> ## 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 Config

> Return the static onboarding wizard configuration.

Backs the wizard frame — steps list, required flags, help links,
recommended connectors, and trial parameters.



## OpenAPI

````yaml /openapi.json get /v1/onboarding/config
openapi: 3.1.0
info:
  description: Causeloop Platform Backend
  title: Causeloop API
  version: 1.0.0
servers: []
security: []
paths:
  /v1/onboarding/config:
    get:
      tags:
        - onboarding
      summary: Get Onboarding Config
      description: |-
        Return the static onboarding wizard configuration.

        Backs the wizard frame — steps list, required flags, help links,
        recommended connectors, and trial parameters.
      operationId: get_onboarding_config_v1_onboarding_config_get
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingConfig'
          description: Successful Response
      security:
        - HTTPBearer: []
components:
  schemas:
    OnboardingConfig:
      description: Spec shape for GET /onboarding/config (C-022).
      properties:
        alert_defaults:
          $ref: '#/components/schemas/OnboardingAlertDefaults'
        connector_catalog:
          items:
            $ref: '#/components/schemas/ConnectorCatalogEntry'
          title: Connector Catalog
          type: array
        invite_defaults:
          $ref: '#/components/schemas/OnboardingInviteDefaults'
        welcome:
          $ref: '#/components/schemas/OnboardingWelcome'
      required:
        - welcome
        - connector_catalog
        - alert_defaults
        - invite_defaults
      title: OnboardingConfig
      type: object
    OnboardingAlertDefaults:
      properties:
        threshold:
          title: Threshold
          type: number
        window:
          title: Window
          type: string
      required:
        - threshold
        - window
      title: OnboardingAlertDefaults
      type: object
    ConnectorCatalogEntry:
      properties:
        icon:
          anyOf:
            - type: string
            - type: 'null'
          title: Icon
        id:
          title: Id
          type: string
        label:
          title: Label
          type: string
      required:
        - id
        - label
      title: ConnectorCatalogEntry
      type: object
    OnboardingInviteDefaults:
      properties:
        role:
          title: Role
          type: string
        seats_available:
          title: Seats Available
          type: integer
      required:
        - role
        - seats_available
      title: OnboardingInviteDefaults
      type: object
    OnboardingWelcome:
      properties:
        subtitle:
          title: Subtitle
          type: string
        title:
          title: Title
          type: string
      required:
        - title
        - subtitle
      title: OnboardingWelcome
      type: object
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http

````