View onboardings

get

https://nexhealth.info/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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

subdomain

string

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.

status

string

enum

Filter by status

Allowed:

start_cursor

string

First item of the current page. Starts empty

end_cursor

string

Last item of the current page. Starts empty

per_page

int32

Defaults to 5

Number of results to return per page. Maximum allowed amount is 1000.

sort

string

Defaults to -created_at

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

Nex-Api-Version

string

required

Defaults to v3.0.0

The NexHealth API version

Responses

200Successful

400Bad Request

401Unauthorized

403Forbidden

500Internal Server Error