---
title: "Get onboarding state"
method: GET
path: "/onboarding/state"
tags: ["Onboarding"]
---

# 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).
- `projectId` string, uuid — Project whose onboarding state to bind (sample-issue attempt and project-scoped facts). Auto-filled from CLI and SDK context when omitted.

## Response `200`

OK

- object
  - `onboarding` object, required
    - `gate` 'needs-onboarding' | 'blocked' | 'access-denied' | 'ready', required
    - `canonicalStep` 'verify-email' | 'accept-invite' | 'create-organization' | 'billing' | 'configure-project' | 'connect-github-account' | 'install-github-app' | 'configure-code-search' | 'install-slack-app' | 'configure-slack-notifications' | 'trigger-issue' | 'confirm-issue' | 'finish', nullable, required
    - `organizationId` string, nullable, required
    - `projectId` string, nullable, required
    - `completionByStep` object, required
    - `githubSkipped` boolean, required
    - `githubAppSkipped` boolean, required
    - `slackSkipped` boolean, required
    - `sampleIssueId` string, nullable, required
    - `actorRole` 'admin' | 'member', nullable, required
    - `requiredStep` union, required
      - 'verify-email' | 'accept-invite' | 'create-organization' | 'billing' | 'configure-project' | 'connect-github-account' | 'install-github-app' | 'configure-code-search' | 'install-slack-app' | 'configure-slack-notifications' | 'trigger-issue' | 'confirm-issue' | 'finish'
      - 'select-organization'
    - `isCompleted` boolean, required
    - `onboardingRecommendationsThreadId` string, nullable, required
    - `hasOrganizations` boolean, required
    - `hasPaidBillingSubscription` boolean, required
    - `billingStepEnabled` boolean, required
    - `pendingInvitations` object[], required
      - `invitationId` string, required
      - `organizationId` string, required
      - `organizationName` string, required
      - `organizationSlug` string, required
      - `organizationImageUrl` string, nullable, required
      - `inviterName` string, nullable, required

---

[API](https://skmtc.dev/sazabi/apis/sazabi-public-api.md) · [All operations](https://skmtc.dev/sazabi/apis/sazabi-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/sazabi/sazabi-public-api/revisions/1d12b71c735a/schema)