View 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
Filter by institution subdomain. Must be a subdomain your application has access to (as returned by the API in a previous query); an unknown or inaccessible subdomain returns 403 Forbidden. When omitted, onboardings for all of your organization's institutions are returned, including onboardings not yet matched to an institution.
Filter by status
First item of the current page. Starts empty
Last item of the current page. Starts empty
Number of results to return per page. Maximum allowed amount is 1000.
Optional comma-separated string of fields to sort on. Include a leading dash for descending order.
Available fields:
- created_at
- -created_at
- status
- -status
- subdomain
- -subdomain
Headers
The NexHealth API version
Response
Successful
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"
}
],
"page_info": {
"has_previous_page": false,
"has_next_page": false,
"start_cursor": "AAAAA",
"end_cursor": "BBBBBB"
}
}