On this page
suggestion
query · in the family Suggestion
What it does
Look up one record — a suggestion — something the desk noticed and drafted a plan for, yours to take or decline.
A Suggestion by id, within the caller's OWN org-group family; requires authentication. A cross-tenant id reads as null (not-found) AND trips the rootId tripwire server-side.
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
- Warehouse Associate
- Sales Associate
- An API key whose scope allows
api:suggestion
Arguments
| Name | Type | Required | Notes |
|---|---|---|---|
id | ID ID! | yes | The id of the record. |
Returns
Suggestion — A Suggestion: a declared SKILL's detector minted this offer from bounded live reads: the WHY in merchant words, the EVIDENCE refs (exactly what it looked at), a DRAFTED PLAN in wire vocabulary (the {operation, input} shape), and an expiry. System-minted end to end (authorless — no create/edit surface exists; refreshSuggestions is the only entrance). the offer rule: a caller sees only suggestions whose drafted plan THEIR OWN capability could realize — the list filters, the get answers null, and take/decline enforce the same predicate (preview ≡ enforcement). TAKING mints a Scratchpad through the live spine (origin suggestion; the plan lands via the setScratchpadPlan validate/mark path VERBATIM — stale steps arrive MARKED, never repaired); DECLINING stores the learning reason on the record. Every suggestion drills down to the SuggestionSchema that produced it. The ops event domain (at.ops.suggestion.*).
Example request
query ExampleSuggestion($id: ID!) {
suggestion(id: $id) {
id
sysId
type
caption
status
parentId
rootId
createdAt
updatedAt
revisionNum
revision
skill
schemaId
why
dedupKey
expiresAt
takenScratchpadId
declineReason
}
}
Variables:
{
"id": "01900000-0000-7000-8000-37386ae00000"
}
Example response
{
"data": {
"suggestion": {
"id": "01900000-0000-7000-8000-37386ae00000",
"sysId": "SU-EXMP-0000-000F",
"type": "Suggestion",
"caption": "Blue jeans",
"status": "open",
"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",
"skill": "<skill>",
"schemaId": "01900000-0000-7000-8000-e5ee57ab0000",
"why": "<why>",
"dedupKey": "<dedup key>",
"expiresAt": "2027-01-31T00:00:00.000Z",
"takenScratchpadId": "01900000-0000-7000-8000-65ec6b4e0000",
"declineReason": "<decline reason>"
}
},
"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)NOT_FOUND/*— That record could not be found. (NOT_FOUND)