Skip to content
ApiqDevelopers
API v1.64.0Open console
API referenceidentity

Get me

GET/v1/me
Accepts X-Api-Key · oauthClientCredentials · bearer

The caller's resolved AccessContext — who the platform thinks you are

What a console renders its shell from, and the quickest way for an integrator to check a key: the tenant, site and permissions come from the verified credential, never the body.Show moreWhat a console renders its shell from, and the quickest way for an integrator to check a key: the tenant, site and permissions come from the verified credential, never the body. tenantStatus and productionWithheld say what the tenant may do on this deployment, read on this request: the console badges a SUSPENDED tenant from tenantStatus first, then a tenant whose production is withheld from productionWithheld. For a human session passwordSet says whether the account has a password; a false one is offered POST /v1/auth/password/set. accountType says whether the tenant is a BUSINESS or an INDIVIDUAL (absent: treat as BUSINESS), and a human session carries givenName and familyName when they are known (set at signup); an API key or service token carries neither.

Request body

This operation takes no request body.

Responses

  • 200The resolved callerAccessContext
  • 401
    UNAUTHENTICATED — missing or expired token.Show moreUNAUTHENTICATED — missing or expired token. Declared on every operation because `security` is declared globally at the document root: every route is authenticated, so every route can answer 401.
    ApiErrorResponse
  • 405
    VALIDATION — the public edge serves GET, POST, PUT, PATCH and DELETE only; any other method is refused before the platform sees it (details.reason METHOD_NOT_ALLOWED, details.source edge).Show moreVALIDATION — the public edge serves GET, POST, PUT, PATCH and DELETE only; any other method is refused before the platform sees it (details.reason METHOD_NOT_ALLOWED, details.source edge). Not retryable as sent.
    ApiErrorResponse
  • 414
    VALIDATION — the request URI (path and query string) is longer than 8 KiB; the public edge refuses it before the platform sees it (details.reason URI_TOO_LONG, details.source edge).Show moreVALIDATION — the request URI (path and query string) is longer than 8 KiB; the public edge refuses it before the platform sees it (details.reason URI_TOO_LONG, details.source edge). Not retryable as sent: send long input in the body of a POST.
    ApiErrorResponse
  • 500INTERNAL — a bug, and traceId is the support handle.ApiErrorResponse

Errors you should handle

Branch on code and honour retryable — never on the HTTP status alone.

401UNAUTHENTICATED
The bearer token is expired. Re-authenticate and retry.
not retryable
405VALIDATION
This method is not served.
not retryable
414VALIDATION
The request URI is longer than 8 KiB.
not retryable
500INTERNAL
An unexpected error occurred. Quote the traceId to support.
retryable