Skip to main content
GET
Get the signed-in user

Authorizations

Authorization
string
header
required

Personal Access Token. Send as Authorization: Bearer hq_pat_....

Response

200 - application/json

The signed-in user's self-view

counts
object
required
identity
object
required
is_operator
boolean
required

True when this caller is an HQ platform operator: an admin of an is_platform tenant (migration 0182; today tic). Drives whether the SPA shows the /operator back-office nav + route. Presentation only - the real boundary is platform_admin::require_operator on /v1/admin/*.

onboarding
object
required

Onboarding v2 state (docs/onboarding-v2.md). The web-ui router reads this to enforce the hard gate client-side - the same state the API enforces as a 409 - so /me is the single source of truth.

out_of_credits
boolean
required

True when the workspace is out of HQ credits. The SPA mirrors the API's 402 hard-block by disabling the New-thread / New-ask actions + composer and showing an "upgrade to continue" prompt. Presentation only - the real boundary is the 402 on the create + send endpoints.

persona
null | object