View providers (beta)

get

https://nexhealth.info/providers

🚧
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[].cell_phone_number, data[].home_phone_number, data[].phone_number, data[].work_phone_extension (+1 more); and other schema changes.

This endpoint returns the providers for the institution, narrowed down by the optional filters configured.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

subdomain

string

required

Used to scope the request to the specified institution

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

Optional comma-separated string of fields to sort on.
Include a leading dash for descending order.

Available fields:

updated_at
-updated_at

location_id

int32

Only return providers associated with the specified Location Id

foreign_id

string

Unique appointment id from the EHR

requestable

boolean

Only return providers who are bookable via NexHealth online booking at the specified location_id

inactive

boolean

Defaults to false

Filter result set based on inactive status, defaults to false if not specified

updated_since

date-time

Query providers whose records have updated since the specified datetime in ISO8601 format. Must be a parseable Date, recommended formats are YYYY-MM-DD or YYYY-MM-DDThh:mm:ss+0000

ids[]

array of int32s

NexHealth IDs

ids[]

Headers

Nex-Api-Version

string

required

Defaults to v3.1.0

The NexHealth API version

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful

400Bad Request

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error