On this page

myAppData

What it does

Read one of your own saved per-app preferences. Never saved yet reads as empty — that’s normal.

ONE of your own app-private values at this organization. ABSENT = null, never an error — absence is a legal preference state. 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:myAppData

Arguments

Name	Type	Required	Notes
`app`	String `String!`	yes	No further notes.
`name`	String `String!`	yes	No further notes.

Returns

MyAppDataEntry — One of the calling user's own app-private values.

Example request

query ExampleMyAppData($app: String!, $name: String!) {
  myAppData(app: $app, name: $name) {
    app
    name
    value
    createdAt
    updatedAt
    revision
    revisionNum
  }
}

Variables:

{
  "app": "<app>",
  "name": "Blue jeans"
}

Example response

{
  "data": {
    "myAppData": {
      "app": "<app>",
      "name": "Blue jeans",
      "value": "<value>",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "revisionNum": 1
    }
  },
  "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)