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

# Get onboarding status

> Get the onboarding workspace status using the temporary onboarding token.

Required scope: `account:read`.



## OpenAPI

````yaml openapi-v2.json GET /api/v2/onboarding/workspaces/{workspaceId}
openapi: 3.1.0
info:
  title: SiteGPT Agent API
  version: 2.0.0
  description: >-
    Agent-facing API for managing SiteGPT chatbots, dashboard summaries,
    appearance media, knowledge, settings, conversations, leads, members,
    account profiles, usage, billing reads, and API tokens.
servers:
  - url: https://sitegpt.ai
security:
  - bearerAuth: []
tags:
  - name: Discovery
  - name: Onboarding
  - name: Account
  - name: Billing
  - name: Tokens
  - name: Chatbots
  - name: Knowledge
  - name: Knowledge Sync Jobs
  - name: Knowledge Sources
  - name: Custom Responses
  - name: Personas
  - name: Instructions
  - name: Settings
  - name: Conversation Starters
  - name: Conversation Followups
  - name: Members
  - name: Leads
  - name: Conversations
  - name: Messages
  - name: Tags
paths:
  /api/v2/onboarding/workspaces/{workspaceId}:
    get:
      tags:
        - Onboarding
      summary: Get onboarding status
      description: >-
        Get the onboarding workspace status using the temporary onboarding
        token.


        Required scope: `account:read`.
      operationId: getOnboardingWorkspace
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful SiteGPT API v2 response.
          content:
            application/json:
              schema:
                type: object
                required:
                  - ok
                  - data
                  - meta
                properties:
                  ok:
                    type: boolean
                    const: true
                  data:
                    type: object
                    additionalProperties: true
                    properties:
                      workspace:
                        $ref: '#/components/schemas/GenericObject'
                      setupChecklist:
                        type: array
                        description: >-
                          Readiness checklist the agent should inspect before
                          sharing the onboarding URL.
                        items:
                          type: object
                          required:
                            - key
                            - label
                            - state
                            - detail
                          additionalProperties: false
                          properties:
                            key:
                              type: string
                              enum:
                                - brand_styling
                                - conversation_starters
                                - followup_prompts
                                - instructions
                                - knowledge
                                - persona
                            label:
                              type: string
                            state:
                              type: string
                              enum:
                                - DONE
                                - PENDING
                                - UNKNOWN
                                - WARNING
                            detail:
                              type: string
                      claimUrl:
                        type: string
                        format: uri
                      onboardingUrl:
                        type: string
                        format: uri
                        description: >-
                          Single user-facing URL where the user can test and
                          claim the chatbot.
                      statusUrl:
                        type: string
                        format: uri
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  workspace:
                    id: workspace-id
                    chatbotId: chatbot-id
                    sourceUrl: https://example.com/
                    normalizedDomain: example.com
                    status: CREATED
                    expiresAt: '2026-05-20T00:00:00.000Z'
                    claim:
                      status: NOT_STARTED
                      email: null
                      plan: null
                      interval: null
                      checkoutUrl: null
                  setupChecklist:
                    - key: knowledge
                      label: Knowledge
                      state: DONE
                      detail: 24/24 trained from Sitemap.
                    - key: persona
                      label: Persona
                      state: DONE
                      detail: 'Custom persona active: Product expert.'
                  claimUrl: >-
                    https://sitegpt.ai/api/v2/onboarding/workspaces/workspace-id/claim
                  onboardingUrl: https://sitegpt.ai/onboarding/preview/workspace-id
                  statusUrl: https://sitegpt.ai/api/v2/onboarding/workspaces/workspace-id
                meta:
                  requestId: request-id
        '400':
          $ref: '#/components/responses/AgentError'
        '401':
          $ref: '#/components/responses/AgentError'
        '403':
          $ref: '#/components/responses/AgentError'
        '404':
          $ref: '#/components/responses/AgentError'
        '405':
          $ref: '#/components/responses/AgentError'
      security:
        - bearerAuth:
            - account:read
components:
  schemas:
    GenericObject:
      type: object
      additionalProperties: true
    AgentResponseMeta:
      type: object
      required:
        - requestId
      properties:
        requestId:
          type: string
        warnings:
          type: array
          items:
            type: string
        nextCursor:
          type:
            - string
            - 'null'
      additionalProperties: true
    AgentError:
      type: object
      required:
        - ok
        - error
        - meta
      properties:
        ok:
          type: boolean
          const: false
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            details: {}
          additionalProperties: false
        meta:
          type: object
          required:
            - requestId
          properties:
            requestId:
              type: string
          additionalProperties: true
      additionalProperties: false
  responses:
    AgentError:
      description: SiteGPT agent API error response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AgentError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: SiteGPT API token

````