Skip to main content
GET
Read the workspace's onboarding checklist state

Authorizations

Authorization
string
header
required

Obtain a token via the CLI auth flow (POST /v1/auth/sessions) or GitHub OAuth

Path Parameters

workspace_id
string
required

UUIDv7 of the workspace.

Response

OK

The whole onboarding checklist, in one call.

cli_ticked
boolean
required

The person ticked the install-the-CLI step by hand.

collapsed
boolean
required

The panel is collapsed but not dismissed.

dismissed
boolean
required

The person dismissed the panel outright.

has_fleet
boolean
required

The workspace holds at least one fleet.

has_processed_event
boolean
required

At least one event has reached the workspace.

has_secret
boolean
required

The workspace holds at least one vault secret.

has_steer_event
boolean
required

At least one of those events came from a steer.

model_configured
boolean
required

A model resolves — the tenant's own selection, or the platform default.