View onboardings

Query Params
string

Filter by subdomain. Ensure the subdomain used is returned by the API in a previous query.

string
enum

Filter by status

Allowed:
string

First item of the current page. Starts empty

string

Last item of the current page. Starts empty

int32
Defaults to 5

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

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
string
required
Defaults to v20240412

The NexHealth API version

Responses

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json