---
title: "Get Admin Onboarding"
method: GET
path: "/api/admin/onboarding"
---

# Get Admin Onboarding

`GET /api/admin/onboarding`

## Request

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

## Query parameters

- `timezone` string, nullable
- `window` string
- `flow_version` integer
- `status` string, nullable
- `milestone` string, nullable
- `search` string, nullable
- `sort` string
- `direction` string
- `limit` integer
- `offset` integer

## Response `200`

Successful Response

- OnboardingReportResponse
  - `generated_at` string, date-time, required
  - `window` object, required
  - `flow_version` integer, required
  - `coverage_started_at` string, date-time, required
  - `telemetry_health` TelemetryHealthResponse, required
    - `status` string, required
    - `accepted_24h` integer, required
    - `duplicate_24h` integer, required
    - `rejected_24h` integer, required
    - `rejection_rate` number, required
    - `last_accepted_at` string, date-time, nullable
    - `coverage_started_at` string, date-time, required
  - `denominator` object, required
  - `milestones` OnboardingMilestoneReportResponse[], required
    - `key` string, required
    - `group` string, required
    - `label` string, required
    - `ordinal` integer, required
    - `reached` integer, required
    - `reached_pct` number, required
    - `active` integer, required
    - `stalled` integer, required
    - `progression_pct` number, required
  - `status_counts` object, required
  - `journeys` OnboardingJourneyResponse[], required
    - `flow_id` string, nullable
    - `user_id` string, nullable
    - `email` string, nullable
    - `display_name` string, nullable
    - `status` string, required
    - `current_milestone` string, nullable
    - `furthest_milestone` string, nullable
    - `started_at` string, date-time, nullable
    - `last_progress_at` string, date-time, nullable
    - `authenticated_at` string, date-time, nullable
    - `completed_at` string, date-time, nullable
    - `elapsed_seconds` integer, nullable
    - `app_version` string, nullable
    - `app_build` string, nullable
  - `total` integer, required
  - `limit` integer, required
  - `offset` integer, required
  - `has_more` boolean, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/yourbeckett/apis/beckett-platform.md) · [All operations](https://skmtc.dev/yourbeckett/apis/beckett-platform/llms.txt) · [OpenAPI document](https://skmtc.dev/yourbeckett/apis/beckett-platform/revisions/a1cb8f2c8961?raw)