Sazabi
APIOnboarding

Get onboarding state

GET
/onboarding/state

Read onboarding progress for the authenticated user.

Query Parameters

organizationId?string

Organization to resolve onboarding state for. User credentials must belong to it. Defaults to the credential's organization context. User tokens must supply it unless the credential's fixed scope resolves it; secret keys may omit it (the key's organization applies).

Length1 <= length
projectId?string

Project whose onboarding state to bind (sample-issue attempt and project-scoped facts). Auto-filled from CLI and SDK context when omitted.

Formatuuid

Response Body

application/json

curl -X GET "https://example.com/onboarding/state"
{  "onboarding": {    "gate": "needs-onboarding",    "canonicalStep": "verify-email",    "organizationId": "string",    "projectId": "string",    "completionByStep": {      "property1": "incomplete",      "property2": "incomplete"    },    "githubSkipped": true,    "githubAppSkipped": true,    "slackSkipped": true,    "sampleIssueId": "string",    "actorRole": "admin",    "requiredStep": "verify-email",    "isCompleted": true,    "onboardingRecommendationsThreadId": "string",    "hasOrganizations": true,    "hasPaidBillingSubscription": true,    "billingStepEnabled": true,    "pendingInvitations": [      {        "invitationId": "string",        "organizationId": "string",        "organizationName": "string",        "organizationSlug": "string",        "organizationImageUrl": "string",        "inviterName": "string"      }    ]  }}