Lists an approver's outstanding approvals. Defaults to the calling user when assignee is omitted. Results are paged: pass the nextCursor from a response as cursor to fetch the next page. A limitSize above 100 is clamped rather than rejected.
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.
Filter by approval status, e.g. Pending.
Cursor from a previous response's nextCursor.
SUCCESS or FAILURE.
Pass as cursor to fetch the next page; null on the last page.
Page size actually applied. Values above 100 are clamped, not rejected.
" } ] }, { "name": "warnings", "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.
" } ] }, { "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/PendingApprovalsResponse", "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": "429", "description": "Salesforce limit exceeded.", "jsonExample": "", "isExpanded": true }, { "statusCode": "500", "description": "Unexpected or upstream failure.", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "VuM4-ets3uNpk7nicShr-", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.nue.io/cpq/approvals \\\n --header 'accept: application/json'" }, { "id": "7eBEtTBiFV_v0INaAraSL", "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/approvals\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "tDCDvA3fhLq_cVTWYq4c9", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/cpq/approvals\")\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": "ijJDO-QAvZhE3EB5hAynQ", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/cpq/approvals\"\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": "VuM4-ets3uNpk7nicShr-" }, "results": { "languages": [ { "id": "aiNkXAKeZ2C3V3XAsKaeK", "language": "200", "code": "// Pending approvals returned.\n{\n \"status\": \"\",\n \"data\": {\n \"assignee\": \"\",\n \"approvals\": [\n {\n \"approvalId\": \"\",\n \"recordId\": \"\",\n \"recordName\": \"\",\n \"processName\": \"\",\n \"stepName\": \"\",\n \"stepStatus\": \"\",\n \"assignedDate\": \"\",\n \"submitter\": \"\"\n }\n ],\n \"nextCursor\": \"\",\n \"limit\": 0\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": "LnLgBZwdcLwLetR6zspk3", "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": "QMbUbRBga45EwBb-xH_xu", "language": "401", "code": "// Authentication failed or the Salesforce session is unavailable.\n" }, { "id": "sjieZQzrZuqtzpNHzHLK_", "language": "429", "code": "// Salesforce limit exceeded.\n" }, { "id": "u3P75qWga5H4Vlbk731ms", "language": "500", "code": "// Unexpected or upstream failure.\n" } ], "selectedLanguageId": "aiNkXAKeZ2C3V3XAsKaeK" } }, "children": [ { "text": "" } ] }