---
title: "GET /api/v1/onboarding/status"
method: GET
path: "/api/v1/onboarding/status"
tags: ["onboarding"]
---

# GET /api/v1/onboarding/status

`GET /api/v1/onboarding/status`

## Request

- Base URL: `https://api.clerkchat.co` (the document declares no server; this is the origin it was published from)
- URL: `https://api.clerkchat.co/api/v1/onboarding/status`
- Auth: none required

## Response `200`

Success

- union
  - object
    - `status` 'incomplete', required
  - object
    - `status` 'not_required', required
    - `organizationId` string, required
  - object
    - `status` 'completed', required
    - `flowId` string, required
    - `flowVersion` union, required
      - number
      - 'Infinity' | '-Infinity' | 'NaN'
    - `organizationId` string, required
    - `completedAt` union, required
      - number
      - 'Infinity' | '-Infinity' | 'NaN'
    - `agentId` string, nullable
    - `organizationSlug` string, nullable

## Other responses

- `401`: Unauthorized
- `503`: PersistenceUnavailable

---

[API](https://skmtc.dev/clerkchat/apis/clerk-chat-api.md) · [All operations](https://skmtc.dev/clerkchat/apis/clerk-chat-api/llms.txt) · [OpenAPI document](https://skmtc.dev/clerkchat/apis/clerk-chat-api/revisions/cc318e39e1d0?raw)