Skip to main content
GET
Get Onboarding Guide State

Authorizations

Authorization
string
header
required

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

Path Parameters

guide_key
string
required

Query Parameters

workspace_id
string<uuid>
required

Response

Successful Response

guide_key
string
required
workspace_id
string<uuid>
required
status
enum<string>
required
Available options:
not_started,
auto_started,
completed,
skipped
auto_start_allowed
boolean
required
first_auto_started_at
string<date-time> | null
last_started_at
string<date-time> | null
completed_at
string<date-time> | null
skipped_at
string<date-time> | null