---
title: "Get Onboarding Status"
method: GET
path: "/api/onboarding/status"
tags: ["onboarding", "onboarding"]
---

# Get Onboarding Status

`GET /api/onboarding/status`

## Request

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

Get current onboarding state for the user.

Returns status, current product, step, and any saved data.
Used by frontend to determine where to resume.

## Response `200`

Successful Response

- OnboardingStatusResponse: Current onboarding state.
  - `status` 'pending' | 'in_progress' | 'skipped' | 'completed', required
  - `product` 'livechat' | 'social-boost' | 'ai-communication', nullable
  - `step` integer
  - `goal` 'get_leads' | 'respond_faster' | 'automate' | 'boost_engagement' | 'manage_inbox' | 'reach_people' | 'capture_leads' | 'nurture', nullable
  - `data` object
  - `completed_at` string, nullable
  - `can_skip` boolean
  - `resume_message` string, nullable
  - `show_superagent_welcome` boolean
  - `superagent_welcome_completed` boolean

---

[API](https://skmtc.dev/dialogbrain/apis/dialogbrain-v2-api-gateway.md) · [All operations](https://skmtc.dev/dialogbrain/apis/dialogbrain-v2-api-gateway/llms.txt) · [OpenAPI document](https://skmtc.dev/dialogbrain/apis/dialogbrain-v2-api-gateway/revisions/77bef09a9209?raw)