Skip to main content
GET
/
v1
/
api
/
onboarding
/
status
Get onboarding status
curl --request GET \
  --url https://api.hq.zone/v1/api/onboarding/status \
  --header 'Authorization: Bearer <token>'
{
  "completed": true,
  "domain_confirmed": true,
  "track": "<string>",
  "business_domain": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Response

200 - application/json

Onboarding status + wizard track

​
completed
boolean
required
​
domain_confirmed
boolean
required
​
track
string
required

Derived from the tenant's corpus source kind: slack / teams / web. Drives which wizard track the SPA renders.

​
business_domain
string | null