Endpoints

View onboardings (beta)

get
https://nexhealth.info/onboardings
šŸš§

Beta

Send Nex-Api-Version: v3.1.0 to use this endpoint. It is still changing, and access is limited to approved partner institutions. Contact NexHealth before you build on it.

Changed from v3.0.0: Adds response fields data[].locations, data[].locations[].city, data[].locations[].data_ready_at, data[].locations[].external_id (+13 more).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requestsā€¦
LoadingLoadingā€¦
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 v3.1.0

The NexHealth API version

Responses

Updated about 2 hours ago

Did this page help you?
Language
Credentials
Header
LoadingLoadingā€¦
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 hours ago

Did this page help you?
ChangelogMCP serverErrorsdevelopers@nexhealth.com