---
title: "First-run checklist"
method: GET
path: "/v1/onboarding"
tags: ["Onboarding"]
---

# First-run checklist

`GET /v1/onboarding`

## Request

- Base URL: `https://api.cadencercs.com`
- URL: `https://api.cadencercs.com/v1/onboarding`
- Auth: HTTP bearer

Computed from real account state, and each step names the API call that completes it — so it is as useful to an agent as to a person.

## Response `200`

Checklist.

- Onboarding
  - `testDevicePath` object: The six calls that reach your own accepted test devices over real RCS, in order, and the checklist steps that do not gate that (email verification, the readiness check, brand submission, carrier launch).
    - `required` object[], required
      - `step` string
      - `api` string
    - `notRequired` object[], required
      - `step` string
      - `why` string
    - `note` string, required
  - `complete` boolean, required
  - `doneCount` number, required
  - `total` number, required
  - `steps` object[], required
    - `id` string, required
    - `title` string, required
    - `detail` string, required
    - `done` boolean, required
    - `next` boolean: Present only on the first incomplete step — the single next action.
    - `api` string: How an agent does this step, so the checklist is self-describing over the API.

## Other responses

- `401`: Not signed in, and no account-linked API key was sent.
- `500`: Unexpected server error. The body is always JSON.

---

[API](https://skmtc.dev/cadencercs/apis/cadence-api.md) · [All operations](https://skmtc.dev/cadencercs/apis/cadence-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cadencercs/apis/cadence-api/revisions/9438443c2081?raw)