Get Approval Status for a Record

1 min

GET

https://api.nue.io/cpq/approval-requests

Returns where a record stands in its approval process: the overall status, whether the record is locked, and a row per approver showing that approver's own status, when it was assigned and acted on, and any rejection message. A row's status is that approval record's individual outcome; stepStatus is the step-level rollup.

The response is the standard approvals envelope: status is SUCCESS or FAILURE, data carries the typed payload, and warnings and errors carry coded messages. Validation and engine failures are reported as coded errors on the envelope rather than as exceptions.

recordIdstringID of the record to read approval status for.

acceptstringGenerated from available response content types

200Approval status returned.

400Missing or invalid parameter.

401Authentication failed or the Salesforce session is unavailable.

404Record not found.

429Salesforce limit exceeded.

500Unexpected or upstream failure.

curl --request GET \
     --url https://api.nue.io/cpq/approval-requests \
     --header 'accept: application/json'