---
title: "View onboardings"
method: GET
path: "/onboardings"
tags: ["Onboardings"]
---

# View onboardings

`GET /onboardings`

Returns the onboardings created by your organization. Each record represents a practice setup flow: either a full onboarding of a new institution or an installation added to an existing institution. Each setup flow appears once: installations that were created as part of an onboarding are represented by their parent onboarding and are not listed separately, although their IDs (e.g. from webhook events) can still be fetched individually via GET /onboardings/:id. Optionally filter by subdomain or status.

## Query parameters

- `subdomain` string
- `status` 'in_progress' | 'complete' | 'failed'
- `start_cursor` string
- `end_cursor` string
- `per_page` integer
- `sort` string

## Headers

- `Nex-Api-Version` string, required

## Response `200`

Successful

- APIV20240412EntitiesApiOnboardingCollectionResponseWithCursor — API_V20240412_Entities_Api_Onboarding_Collection_Response_WithCursor model
  - `code` boolean — Indicates the success or failure of the request
  - `description` string — Additional context on the request to help with debugging.
  - `error` string[] — Any errors that occur during the execution of the request.
  - `data` APIV20240412EntitiesApiOnboarding[]
    - `id` string — The ID of the onboarding process.
    - `created_at` string, date-time — The timestamp the onboarding url was created.
    - `subdomain` string, nullable — The subdomain of the institution this onboarding belongs to. Null until the onboarding has been matched to an institution (e.g. while a new institution is still being set up).
    - `url` string — The link to send to practice staff to complete setup. Format varies by onboarding type. Expires at url_expires_at.
    - `url_expires_at` string, date-time — When the url will expire and no longer be valid.
    - `status` 'in_progress' | 'complete' | 'failed' — Current state of the onboarding. in_progress: the link has been created and setup is not finished; complete: setup finished (including installations completed manually by NexHealth); failed: the onboarding failed, was cancelled, or was disabled and will not proceed.
    - `booking_params` object, nullable — Data collected during setup for online booking. Contains "location_id" (ID of the location selected during setup; may be serialized as an integer or numeric string) and "appointment_type_ids" (array of appointment type IDs), each present only after the corresponding setup step has run. Always null for installation-based onboardings. Before setup begins it is an empty object on the retrieve and create endpoints and null on the list endpoint.
    - `availability_ready_at` string, date-time, nullable — When the onboarding location first became bookable. Null until availability is ready.
  - `page_info` object — Pagination information that can be used for fetching previous and next pages.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error

---

[API](https://skmtc.net/nexhealth/apis/nexhealth-api.md) · [All operations](https://skmtc.net/nexhealth/apis/nexhealth-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nexhealth/nexhealth-api/revisions/a180e830b672/schema)