On this page
myMailLedger
query · in the family Your own session
What it does
Every email the platform sent to your account, newest first — what it was, when, where the request came from, and the reference printed on its last line.
Every email the platform sent to YOUR account: newest-first born-paginated; SELF by construction, no subject argument exists; visible from EVERY workspace of the account. limit defaults 100, clamps at 200 (the shared list-page law). 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:myMailLedger
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
MailLedgerPage MailLedgerPage! — One page of your mail-ledger walk (newest-first across your account's month buckets; walk until nextToken is null).
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 ExampleMyMailLedger($limit: Int) {
myMailLedger(limit: $limit) {
items {
ref
kind
kindWords
origin
originWords
footerSentence
subjectId
eventId
eventAt
sentAt
providerMessageId
recipientHash
}
nextToken
}
}
Variables:
{
"limit": 1
}
Example response
{
"data": {
"myMailLedger": {
"items": [
{
"ref": "01900000-0000-7000-8000-42f484020000",
"kind": "verification",
"kindWords": "<kind words>",
"origin": "office",
"originWords": "<origin words>",
"footerSentence": "<footer sentence>",
"subjectId": "01900000-0000-7000-8000-91fe7ba20000",
"eventId": "<event id>",
"eventAt": "2027-01-31T00:00:00.000Z",
"sentAt": "2027-01-31T00:00:00.000Z",
"providerMessageId": "<provider message id>",
"recipientHash": "<recipient hash>"
}
],
"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)