---
title: "View onboarding"
method: GET
path: "/onboardings/{hashid}"
tags: ["Onboardings"]
---

# View onboarding

`GET /onboardings/{hashid}`

## Request

- Base URL: `https://nexhealth.info`
- URL: `https://nexhealth.info/onboardings/{hashid}`
- Auth: API key in header `Authorization`

Returns a single onboarding by its ID. Responds with 404 if the ID does not exist or was created by another organization.

## Path parameters

- `hashid` string, required

## Headers

- `Nex-Api-Version` string, required

## Response `200`

Successful

- APIV20240412EntitiesApiOnboardingResponse: API_V20240412_Entities_Api_Onboarding_Response 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.
  - `count` integer: Number of total objects, in case of collection.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

---

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