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.
SUCCESS or FAILURE.
This approval row's own status, e.g. Assigned, Approved, Rejected, Reassigned, Revoked.
Step-level rollup, distinct from this row's status.
On a reassigned row, the previous approver's Salesforce User ID; otherwise null.
The approval this row was reassigned from; otherwise null.
A coded message returned on the envelope. Validation and engine failures are reported here rather than thrown, so a FAILURE response is still a well-formed body.
", "modelRef": "#/components/schemas/ApprovalMessage", "customType": "ApprovalMessage[]", "schema": [ { "name": "severity", "kind": "optional", "type": "string", "description": "ERROR, WARNING, or INFO.
Stable machine-readable code, e.g. INVALID_PARAMETER, MISSING_PARAMETER, RECORD_NOT_FOUND.
Human-readable explanation.
" } ] }, { "name": "errors", "kind": "optional", "type": "array", "description": "A coded message returned on the envelope. Validation and engine failures are reported here rather than thrown, so a FAILURE response is still a well-formed body.
", "modelRef": "#/components/schemas/ApprovalMessage", "customType": "ApprovalMessage[]", "schema": [ { "name": "severity", "kind": "optional", "type": "string", "description": "ERROR, WARNING, or INFO.
Stable machine-readable code, e.g. INVALID_PARAMETER, MISSING_PARAMETER, RECORD_NOT_FOUND.
Human-readable explanation.
" } ] } ], "modelRef": "#/components/schemas/ApprovalStatusResponse", "isExpanded": true } ] }, { "statusCode": "400", "description": "Missing or invalid parameter.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Envelope returned by the approval action verbs.", "customType": "ApprovalActionResponse", "schema": [ { "name": "status", "kind": "optional", "type": "string", "description": "SUCCESS or FAILURE.
A coded message returned on the envelope. Validation and engine failures are reported here rather than thrown, so a FAILURE response is still a well-formed body.
", "modelRef": "#/components/schemas/ApprovalMessage", "customType": "ApprovalMessage[]", "schema": [ { "name": "severity", "kind": "optional", "type": "string", "description": "ERROR, WARNING, or INFO.
Stable machine-readable code, e.g. INVALID_PARAMETER, MISSING_PARAMETER, RECORD_NOT_FOUND.
Human-readable explanation.
" } ] }, { "name": "errors", "kind": "optional", "type": "array", "description": "A coded message returned on the envelope. Validation and engine failures are reported here rather than thrown, so a FAILURE response is still a well-formed body.
", "modelRef": "#/components/schemas/ApprovalMessage", "customType": "ApprovalMessage[]", "schema": [ { "name": "severity", "kind": "optional", "type": "string", "description": "ERROR, WARNING, or INFO.
Stable machine-readable code, e.g. INVALID_PARAMETER, MISSING_PARAMETER, RECORD_NOT_FOUND.
Human-readable explanation.
" } ] } ], "modelRef": "#/components/schemas/ApprovalActionResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "Authentication failed or the Salesforce session is unavailable.", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "Record not found.", "jsonExample": "", "isExpanded": true }, { "statusCode": "429", "description": "Salesforce limit exceeded.", "jsonExample": "", "isExpanded": true }, { "statusCode": "500", "description": "Unexpected or upstream failure.", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "s7Fn25UNDbF25LaCotEew", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.nue.io/cpq/approval-requests \\\n --header 'accept: application/json'" }, { "id": "DSC_b__uOYa3vOv1GTxDV", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.nue.io/cpq/approval-requests\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "oTxB5X6raaC20i_b0qeWq", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/cpq/approval-requests\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "ONmiw-UPnxR2WXd2m8uCP", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/cpq/approval-requests\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "s7Fn25UNDbF25LaCotEew" }, "results": { "languages": [ { "id": "_wL5H_mmKFBv-dyC2ahch", "language": "200", "code": "// Approval status returned.\n{\n \"status\": \"\",\n \"data\": {\n \"requestId\": \"\",\n \"recordId\": \"\",\n \"status\": \"\",\n \"isLocked\": false,\n \"submittedMessage\": \"\",\n \"rejectionMessage\": \"\",\n \"steps\": [\n {\n \"approvalId\": \"\",\n \"stepId\": \"\",\n \"stepName\": \"\",\n \"processName\": \"\",\n \"status\": \"\",\n \"stepStatus\": \"\",\n \"approverUserId\": \"\",\n \"originalApproverUserId\": \"\",\n \"reassignedFromApprovalId\": \"\",\n \"rejectionMessage\": \"\",\n \"dependsOnStepId\": \"\",\n \"assignedDate\": \"\",\n \"actedDate\": \"\",\n \"submitter\": \"\"\n }\n ]\n },\n \"warnings\": [\n {\n \"severity\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"errors\": [\n {\n \"severity\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}" }, { "id": "1xMLJAQlxYU-4nqHfPgZn", "language": "400", "code": "// Missing or invalid parameter.\n{\n \"status\": \"\",\n \"data\": {\n \"requestId\": \"\",\n \"recordId\": \"\",\n \"status\": \"\",\n \"isLocked\": false,\n \"approvers\": [\n {\n \"approvalId\": \"\",\n \"stepName\": \"\",\n \"stepStatus\": \"\",\n \"approverUserId\": \"\",\n \"originalApproverUserId\": \"\",\n \"reassignedFromApprovalId\": \"\",\n \"rejectionMessage\": \"\"\n }\n ],\n \"approvals\": [\n {\n \"approvalId\": \"\",\n \"stepName\": \"\",\n \"stepStatus\": \"\",\n \"approverUserId\": \"\",\n \"originalApproverUserId\": \"\",\n \"reassignedFromApprovalId\": \"\",\n \"rejectionMessage\": \"\"\n }\n ]\n },\n \"warnings\": [\n {\n \"severity\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"errors\": [\n {\n \"severity\": \"\",\n \"code\": \"\",\n \"message\": \"\"\n }\n ]\n}" }, { "id": "2o7Olp2yzLfo25dcJ--7p", "language": "401", "code": "// Authentication failed or the Salesforce session is unavailable.\n" }, { "id": "GpTSX8rB3NePQK1HsizhK", "language": "404", "code": "// Record not found.\n" }, { "id": "Bpd-WL4Xh2txOmxvNpO1o", "language": "429", "code": "// Salesforce limit exceeded.\n" }, { "id": "h0KGoua1-KUFKHScX3MJR", "language": "500", "code": "// Unexpected or upstream failure.\n" } ], "selectedLanguageId": "_wL5H_mmKFBv-dyC2ahch" } }, "children": [ { "text": "" } ] }