Skip to main content
GET
/
v1
/
onboarding
Get Onboarding
curl --request GET \
  --url https://api.example.com/v1/onboarding \
  --header 'Authorization: Bearer <token>'
{
  "current_step": "<string>",
  "completed_steps": [
    "<string>"
  ],
  "workspace_created": true,
  "members_invited": 123,
  "connectors_connected": 123,
  "alert_rule_created": true,
  "first_sync": {
    "status": "<string>",
    "issues_ingested": 0
  },
  "updated_at": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Successful Response

Flattened onboarding state returned by the API.

Maps the internal _SEED_ONBOARDING dict to a clean response shape. Spec shape (C-022): current_step, completed_steps, workspace_created, members_invited, connectors_connected, alert_rule_created, first_sync, updated_at

​
current_step
string
required
​
completed_steps
string[]
required
​
workspace_created
boolean
required
​
members_invited
integer
required
​
connectors_connected
integer
required
​
alert_rule_created
boolean
required
​
first_sync
FirstSyncStatus · object
required
​
updated_at
string
required