Skip to main content
GET
/
v1
/
api
/
me
Get my profile
curl --request GET \
  --url https://api.hq.zone/v1/api/me \
  --header 'Authorization: Bearer <token>'
{
  "counts": {
    "schedules_owned": 123
  },
  "identity": {
    "discovered_at": "2023-11-07T05:31:56Z",
    "external_user_id": "<string>",
    "is_admin": true,
    "is_bot": true,
    "profile_consent": "<string>",
    "source_kind": "<string>",
    "tenant_slug": "<string>",
    "time_format": "<string>",
    "time_zone": "<string>",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "avatar_url": "<string>",
    "display_name": "<string>",
    "email": "<string>",
    "last_seen_at": "2023-11-07T05:31:56Z",
    "locale": "<string>",
    "real_name": "<string>",
    "source_workspace": "<string>",
    "title": "<string>",
    "tz": "<string>"
  },
  "onboarding": {
    "track": "<string>",
    "unread_notifications": 123,
    "business_domain": "<string>",
    "completed_at": "2023-11-07T05:31:56Z",
    "domain_confirmed_at": "2023-11-07T05:31:56Z"
  },
  "out_of_credits": true,
  "persona": {
    "generated_at": "2023-11-07T05:31:56Z",
    "message_count": 123,
    "profile": "<unknown>",
    "prompt_version": 123,
    "last_message_at": "2023-11-07T05:31:56Z",
    "model": "<string>"
  }
}

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
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
object