Skip to main content

List Approval Groups

Queries approval groups in the current organization with pagination.

Request URL: /openapi/v1/approval/group/list

Request Method: POST

Request Parameters

ParameterTypeRequiredDescriptionExample
currentIntegerNoPage number. Starts from 1. Default value: 1.1
pageSizeIntegerNoNumber of records per page. Default value: 10.10

Request Example

{
"current": 1,
"pageSize": 10
}

Response Parameters

ParameterTypeDescriptionExample
successBooleanWhether the request is successful.true
requestIdStringRequest ID for troubleshooting and tracing.Nc2e9WDR-KQQRiTAnQOJf6ZTdMPk6TVB
dataArrayApproval group list. See data Fields.[{...}]
currentIntegerCurrent page number.1
pageSizeIntegerNumber of records per page.10
totalIntegerTotal number of records that match the query conditions.16
errorCodeStringError code returned when the call fails.None
messageStringError message returned when the call fails.None

data Fields

ParameterTypeDescriptionExample
idLongApproval group ID.48
nameStringApproval group name.Default Production Approval Flow
resourceNumIntegerNumber of bound resources.24
descriptionStringApproval group description.Default Production Approval Flow
isDefaultBooleanWhether this is a default approval group.true
createTimeStringTime when the approval group was created.2023-02-17 04:48:55Z
specifyApproverBooleanWhether an approver must be specified when submitting an approval.true
selfApprovalBooleanWhether the submitter can approve their own request.false

Successful Invocation Example

{
"success": true,
"requestId": "Nc2e9WDR-KQQRiTAnQOJf6ZTdMPk6TVB",
"data": [
{
"id": 48,
"name": "Default Production Approval Flow",
"resourceNum": 24,
"description": "Default Production Approval Flow",
"isDefault": true,
"createTime": "2023-02-17 04:48:55Z",
"specifyApprover": true,
"selfApproval": true
},
{
"id": 49,
"name": "Default Development Approval Flow",
"resourceNum": 15,
"description": "Default Development Approval Flow",
"isDefault": true,
"createTime": "2023-02-17 04:48:55Z",
"specifyApprover": true,
"selfApproval": false
}
],
"current": 1,
"pageSize": 10,
"total": 16
}