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

# Get Onboarding Status

`GET /api/onboarding/status`

## Request

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

Return company setup signal and per-tour progress for the current user.

## Query parameters

- `company_uuid` string, uuid, required: Active company UUID

## Headers

- `X-User-Email` string, nullable
- `X-User-Name` string, nullable

## Response `200`

Successful Response

- OnboardingStatusResponse
  - `company_setup_complete` boolean, required
  - `tours` object, required: Status per tour id; missing ids are treated as pending by clients.

## Other responses

- `404`: Not found
- `422`: Validation Error

---

[API](https://skmtc.dev/regdoor/apis/regdoor-api.md) - [All operations](https://skmtc.dev/regdoor/apis/regdoor-api/llms.txt) - [OpenAPI document](https://skmtc.dev/regdoor/apis/regdoor-api/revisions/7642336631af?raw)
