On this page
myAccount
query · in the family Your own session
What it does
Your own sign-in account’s details — login name, email, and the account record’s facts.
The calling principal's OWN Account identity. USER-plane only (api/device/consumer sessions have no acting account face). 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:myAccount
Returns
MyAccount MyAccount! — The calling principal's OWN Account — the sign-in identity subset.
Example request
query ExampleMyAccount {
myAccount {
id
sysId
caption
loginName
email
status
createdAt
updatedAt
revisionNum
revision
}
}
Example response
{
"data": {
"myAccount": {
"id": "01900000-0000-7000-8000-37386ae00000",
"sysId": "<sys id>",
"caption": "Blue jeans",
"loginName": "Blue jeans",
"email": "<the person’s email address>",
"status": "<status>",
"createdAt": "2027-01-31T00:00:00.000Z",
"updatedAt": "2027-01-31T00:00:00.000Z",
"revisionNum": 1,
"revision": "01900000-0000-7000-8000-b7960e180000"
}
},
"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)