Sign in
preferences

Get Onboarding Guide State

Return whether an onboarding guide may auto-start for this user/workspace.

get/v1/preferences/onboarding/{guide_key}

Path parameters

guide_keystring required

Query parameters

workspace_idstring uuid required

Response

Successful Response

guide_keystring required
workspace_idstring uuid required
status'not_started' | 'auto_started' | 'completed' | 'skipped' required
auto_start_allowedboolean required
first_auto_started_atstring date-time nullable
last_started_atstring date-time nullable
completed_atstring date-time nullable
skipped_atstring date-time nullable

Changes