Get Onboarding State

GET

/api/canvas/onboarding

curl --request GET \
  --url https://example.com/api/canvas/onboarding \
  --header 'Authorization: Bearer <token>'

Get the full onboarding state for the current user.

Authorizations

• HTTPBearer

Responses

200

Successful Response

Media type application/json

OnboardingStateResponse

object

wizard_completed

required

Wizard Completed

boolean

wizard_dismissed

required

Wizard Dismissed

boolean

checklist_dismissed

required

Checklist Dismissed

boolean

steps_completed

required

Steps Completed

object

key

additional properties

boolean

Example ^generated

{
  "wizard_completed": true,
  "wizard_dismissed": true,
  "checklist_dismissed": true,
  "steps_completed": {
    "additionalProperty": true
  }
}