List Approval Processes

1 min

GET

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

Lists the approval processes configured for an object, in the order the engine evaluates them. Supply either objectType or recordId; when recordId is supplied the object is derived from it and only processes applicable to that record are returned.

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.

objectTypestring<p>Object to list processes for, e.g. <code>Quote</code>. Required unless <code>recordId</code> is supplied.</p>

recordIdstring<p>Record to derive the object from. Required unless <code>objectType</code> is supplied.</p>

activeOnlybooleanReturn only active processes.

acceptstringGenerated from available response content types

200Approval processes 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-processes \
     --header 'accept: application/json'