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

# Onboarding Status

`GET /api/onboarding/status`

## Request

- Base URL: `https://www.gateco.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://www.gateco.ai/api/onboarding/status`
- Auth: OAuth 2 (password, token URL `/api/auth/login`)

Return the guided setup wizard state for the authenticated user's organization.

The response envelope matches the standard Gateco `{ data: {...} }` shape.
A top-level `dismissed` field indicates whether the admin has already
dismissed the wizard (derived from `organization.onboarding_dismissed_at`).

Returns:
    JSON body:
        data: OnboardingStatus dict with `steps`, `completed_count`, and
              `total_count`.
        dismissed: bool — True when the organization has dismissed the wizard.

## Response `200`

Successful Response

- unknown

---

[API](https://skmtc.dev/gateco/apis/gateco-api.md) · [All operations](https://skmtc.dev/gateco/apis/gateco-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gateco/apis/gateco-api/revisions/5debaf204950?raw)