Description

Query approval flow instance list

Request Specification

Method: POST + application/json

Endpoint: https://${cloud domain}/cgi/crm/approvalInstances/query?thirdTraceId=${Random String}

Headers: Refer to Common Parameters

Request Parameters

Parameter	Type	Required	Description
includeNull	Boolean	No	Whether to include null fields. false: not returned, true: returned. Default is false
flowApiName	String	Yes	Approval flow apiName
state	String	No	Flow status: in_progress (processing), pass (approved), error (error), cancel (cancelled), reject (rejected)
startTime	String	Yes	Start time (timestamp format)
endTime	String	Yes	End time (timestamp format)
objectApiName	String	No	Data object apiName
pageNumber	Int	No	Page number, default 1
pageSize	Int	No	Page size, default 20

Request Example

{
  "includeNull": true,
  "pageNumber": 1,
  "flowApiName": "hello",
  "pageSize": 1,
  "startTime": "hello",
  "objectApiName": "hello",
  "state": "hello",
  "endTime": "hello"
}

Response Parameters

Parameter	Type	Description
traceId	string	Request unique ID
errorDescription	string	Error description
errorMessage	string	Error message
errorCode	Int	Error codes

Response Example

{
  "traceId": "E-O.827xxxxxx",
  "errorDescription": "success",
  "errorMessage": "OK",
  "errorCode": 0
}

Notes

• Do not use the message field in the response for logical judgment, as errorMessage may change;