On this page
myNotifications
query · in the family Your own session
What it does
Your notices — platform alerts about your own account, newest first, in any of your workspaces. Unread ones have no read mark yet.
Your notices. limit defaults 50, clamps at 100. Requires authentication.
Who may call it
Capability area: Your own session — What every signed-in person may do for themselves — their session, their profile and their own work.
- Owner
- System Administrator
- Manager
- Associate Manager
- Warehouse Associate
- Sales Associate
- Cashier
- An API key whose scope allows
api:myNotifications
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
NotificationRefPage NotificationRefPage! — One page of the notice walk.
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 ExampleMyNotifications($limit: Int) {
myNotifications(limit: $limit) {
items {
id
kind
severity
occasionAt
tokenAccountId
fraudAlertId
searchJobId
exportJobId
trainingCertificateId
trainingRequirementId
changeTag
fillDraftId
createdAt
readAt
}
nextToken
}
}
Variables:
{
"limit": 1
}
Example response
{
"data": {
"myNotifications": {
"items": [
{
"id": "01900000-0000-7000-8000-37386ae00000",
"kind": "burn_breach",
"severity": "blocking",
"occasionAt": "2027-01-31T00:00:00.000Z",
"tokenAccountId": "01900000-0000-7000-8000-fe33c4e80000",
"fraudAlertId": "01900000-0000-7000-8000-223d82c00000",
"searchJobId": "01900000-0000-7000-8000-72c20bfd0000",
"exportJobId": "01900000-0000-7000-8000-7f349a170000",
"trainingCertificateId": "01900000-0000-7000-8000-8ec2818b0000",
"trainingRequirementId": "01900000-0000-7000-8000-8c4e9c9f0000",
"changeTag": "<change tag>",
"fillDraftId": "01900000-0000-7000-8000-9058a5560000",
"createdAt": "2027-01-31T00:00:00.000Z",
"readAt": "2027-01-31T00:00:00.000Z"
}
],
"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)