On this page
me
query · in the family Your own session
What it does
Who am I — the signed-in session’s own identity. Reads nothing but your session.
The current authenticated principal, or null when the call is unauthenticated.
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:me
Returns
Principal — A resolved session principal — what an authenticated call acts as.
Example request
query ExampleMe {
me {
sessionId
kind
userId
accountId
apiKeyId
deviceId
deviceType
registerId
logicalFacilityId
orgId
rootId
capability
groupCaption
roleCaptions
}
}
Example response
{
"data": {
"me": {
"sessionId": "01900000-0000-7000-8000-be25a35a0000",
"kind": "<kind>",
"userId": "01900000-0000-7000-8000-11f967df0000",
"accountId": "01900000-0000-7000-8000-fec33a710000",
"apiKeyId": "01900000-0000-7000-8000-d64fbf430000",
"deviceId": "01900000-0000-7000-8000-7c291d9e0000",
"deviceType": "<device type>",
"registerId": "01900000-0000-7000-8000-c30413dd0000",
"logicalFacilityId": "01900000-0000-7000-8000-8026f71c0000",
"orgId": "01900000-0000-7000-8000-b0cf4f3c0000",
"rootId": "01900000-0000-7000-8000-a093dd800000",
"capability": "<capability>",
"groupCaption": "Blue jeans",
"roleCaptions": [
"<role captions>"
]
}
},
"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)