On this page
approvalRequests
query · in the family Approval request
What it does
The approval request list — each entry is an approval request — asking a manager’s authority for an act above your limit.
The caller's org-group family's ACTIVE LISTING of ApprovalRequests — doomed records DROP from listings. PAGINATED: limit clamps to [1, 200], default 100; nextToken = the prior page's cursor, verbatim — opaque + tenant-bound (a malformed or foreign token → VALIDATION/INVALID). Walk until nextToken is null (a page may hold fewer than limit — doomed drop per page).
What happens
Reads only — changes nothing.
Who may call it
Capability area: Reading your records — Looking up and listing the records of your organization.
- Owner
- System Administrator
- Manager
- Associate Manager
- Sales Associate
- Cashier
- An API key whose scope allows
api:approvalRequests
Arguments
| Name | Type | Required | Notes |
|---|---|---|---|
limit | Int | no | How many records to answer at most; a page may hold fewer. |
nextToken | String | no | The cursor from the previous page, passed back exactly as received. |
Returns
ApprovalRequestPage ApprovalRequestPage! — One page of the approvalRequests listing — the records + the opaque resume cursor.
This is a page: items holds the records and nextToken the cursor for the next page — pass it back verbatim until it is null. See paging.
Example request
query ExampleApprovalRequests($limit: Int) {
approvalRequests(limit: $limit) {
items {
id
sysId
type
caption
status
parentId
rootId
createdAt
updatedAt
revisionNum
revision
action
targetType
targetId
valueMinor
requestedBy
requiredTier
reason
expiresAt
decidedBy
decidedAt
decisionReason
}
nextToken
}
}
Variables:
{
"limit": 1
}
Example response
{
"data": {
"approvalRequests": {
"items": [
{
"id": "01900000-0000-7000-8000-37386ae00000",
"sysId": "AR-EXMP-0000-000F",
"type": "ApprovalRequest",
"caption": "Blue jeans",
"status": "pending",
"parentId": "01900000-0000-7000-8000-065235280000",
"rootId": "01900000-0000-7000-8000-a093dd800000",
"createdAt": "2027-01-31T00:00:00.000Z",
"updatedAt": "2027-01-31T00:00:00.000Z",
"revisionNum": 1,
"revision": "01900000-0000-7000-8000-b7960e180000",
"action": "<action>",
"targetType": "<target type>",
"targetId": "01900000-0000-7000-8000-446adfd50000",
"valueMinor": 1,
"requestedBy": "01900000-0000-7000-8000-dae980de0000",
"requiredTier": "owner",
"reason": "Correcting a miscount.",
"expiresAt": "2027-01-31T00:00:00.000Z",
"decidedBy": "01900000-0000-7000-8000-d4d316ba0000",
"decidedAt": "2027-01-31T00:00:00.000Z",
"decisionReason": "<decision reason>"
}
],
"nextToken": "<the cursor from the previous page>"
}
},
"extensions": {
"at": {
"callId": "01EXAMPLE-CALL-ID",
"version": {
"requested": null,
"serviced": {
"name": "genesis",
"number": 0
}
}
}
}
}
Errors this call can answer
VALIDATION/INVALID— Something in the request is not valid. (VALIDATION)AUTHN/REQUIRED— Sign in to do this. (AUTHN)AUTHZ/FORBIDDEN— Your role does not allow this action. (AUTHZ)RATE_LIMIT/THROTTLED— Too many requests in a short time. (RATE_LIMIT)