---
title: "GET /api/v1/dashboard"
method: GET
path: "/api/v1/dashboard"
tags: ["dashboardSummary"]
---

# GET /api/v1/dashboard

`GET /api/v1/dashboard`

## 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/dashboard`
- Auth: none required

## Response `200`

Success

- union
  - object
    - `status` 'onboarding', required
    - `onboarding` union, required
      - 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
  - object
    - `status` 'no_workspace', required
    - `onboarding` union, required
      - 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
  - object
    - `status` 'ready', required
    - `access` ProductAccessEncoded, required
      - `userId` string, required
      - `organizationId` string, required
      - `organizationName` string, required
      - `organizationSlug` string, required
      - `role` string, required
      - `userName` string, required
    - `agents` AgentListResponseEncoded, required
      - `agents` AgentEncoded[], required
        - `id` string, required
        - `organizationId` string, required
        - `name` string, required
        - `slug` string, required
        - `role` 'Customer support' | 'Sales agent' | 'Shopping assistant', required
        - `instructions` string, required
        - `translationLanguage` 'Adaptive' | 'English' | 'Chinese' | 'Hindi' | 'Spanish' | 'French' | 'Arabic' | 'Bangla' | 'Portuguese' | 'Indonesian' | 'Japanese' | 'Swahili' | 'German' | 'Korean' | 'Italian' | 'Yoruba' | 'Burmese', required
        - `welcomeMessage` string, nullable, required
        - `avatarUrl` string, nullable, required
        - `conversationStarters` unknown[], required
          - unknown
        - `playgroundModelId` 'deepseek/deepseek-v4-pro-0813' | 'deepseek/deepseek-v4.1-flash' | 'deepseek/deepseek-v4.1-flash-fast' | 'openai/gpt-5.6-luna', required
        - `publicTemplateEnabled` boolean, required
        - `status` 'draft' | 'active' | 'archived', required
        - `brandProfile` WebsiteBrandProfileSummaryEncoded, required
          - `websiteUrl` string, required
          - `resolvedUrl` string, nullable, required
          - `hostname` string, required
          - `title` string, nullable, required
          - `description` string, nullable, required
          - `faviconUrl` string, nullable, required
          - `appleTouchIconUrl` string, nullable, required
          - `ogImageUrl` string, nullable, required
          - `themeColor` string, nullable, required
          - `canonicalUrl` string, nullable, required
          - `status` 'queued' | 'running' | 'completed' | 'failed', required
          - `fetchedAt` union, required
            - number
            - 'Infinity' | '-Infinity' | 'NaN'
        - `createdByUserId` string, required
        - `createdAt` union, required
          - number
          - 'Infinity' | '-Infinity' | 'NaN'
        - `updatedAt` union, required
          - number
          - 'Infinity' | '-Infinity' | 'NaN'
    - `credits` BillingCreditsStatusEncoded, required
      - `used` union, required
        - number
        - 'Infinity' | '-Infinity' | 'NaN'
      - `limit` union, required
        - number
        - 'Infinity' | '-Infinity' | 'NaN'
      - `resetAt` union, required
        - number
        - 'Infinity' | '-Infinity' | 'NaN'
    - `onboarding` union, required
      - 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

- `400`: BadRequest
- `401`: Unauthorized
- `403`: Forbidden
- `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)