> ## Documentation Index
> Fetch the complete documentation index at: https://docs.causeloop.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Onboarding

> Current onboarding state machine snapshot for the workspace.



## OpenAPI

````yaml /openapi.json get /v1/onboarding
openapi: 3.1.0
info:
  description: Causeloop Platform Backend
  title: Causeloop API
  version: 1.0.0
servers: []
security: []
paths:
  /v1/onboarding:
    get:
      tags:
        - onboarding
      summary: Get Onboarding
      description: Current onboarding state machine snapshot for the workspace.
      operationId: get_onboarding_v1_onboarding_get
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingStateResponse'
          description: Successful Response
      security:
        - HTTPBearer: []
components:
  schemas:
    OnboardingStateResponse:
      description: |-
        Flattened onboarding state returned by the API.

        Maps the internal _SEED_ONBOARDING dict to a clean response shape.
        Spec shape (C-022):
          current_step, completed_steps, workspace_created, members_invited,
          connectors_connected, alert_rule_created, first_sync, updated_at
      properties:
        alert_rule_created:
          title: Alert Rule Created
          type: boolean
        completed_steps:
          items:
            type: string
          title: Completed Steps
          type: array
        connectors_connected:
          title: Connectors Connected
          type: integer
        current_step:
          title: Current Step
          type: string
        first_sync:
          $ref: '#/components/schemas/FirstSyncStatus'
        members_invited:
          title: Members Invited
          type: integer
        updated_at:
          title: Updated At
          type: string
        workspace_created:
          title: Workspace Created
          type: boolean
      required:
        - current_step
        - completed_steps
        - workspace_created
        - members_invited
        - connectors_connected
        - alert_rule_created
        - first_sync
        - updated_at
      title: OnboardingStateResponse
      type: object
    FirstSyncStatus:
      properties:
        issues_ingested:
          default: 0
          title: Issues Ingested
          type: integer
        status:
          title: Status
          type: string
      required:
        - status
      title: FirstSyncStatus
      type: object
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http

````