v1

latestOpenAPI 3.0.0NexHealth License 1.02026-07-2688180386.6 KB

Onboardings

View onboarding

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

get/onboardings/{hashid}

Path parameters

hashidstring required

The ID of the onboarding, as returned in the id field by the list and create endpoints.

Headers

Nex-Api-Versionstring required

The NexHealth API version

Response

Successful

codeboolean

Indicates the success or failure of the request

descriptionstring

Additional context on the request to help with debugging.

errorstring[]

Any errors that occur during the execution of the request.

countinteger

Number of total objects, in case of collection.

Example response

{
  "description": "Description",
  "error": [
    "Error message"
  ],
  "data": {
    "id": "y2wxl82zldm4",
    "created_at": "2026-01-01T00:00:00Z",
    "subdomain": "test-subdomain",
    "url": "https://app.nexhealth.com/onboardings/y2wxl82zldm4",
    "url_expires_at": "2026-02-01T00:00:00Z",
    "status": "in_progress",
    "booking_params": {
      "location_id": 105,
      "appointment_type_ids": [
        19,
        20
      ]
    },
    "availability_ready_at": "2026-01-01T00:00:00Z"
  },
  "count": 2
}