API Reference

View providers

get
https://nexhealth.info/providers

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Used to scope the request to the specified institution

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

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

Available fields:

  • updated_at
  • -updated_at
int32

Only return providers associated with the specified Location Id

string

Unique provider id from the EHR

boolean

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

boolean
Defaults to false

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

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

include[]
array of strings

Resources to be included in the response

include[]
Allowed:
ids[]
array of int32s

NexHealth IDs

ids[]
Headers
string
required
Defaults to v3.0.0

The NexHealth API version

Responses

Updated about 2 months 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 months ago

Did this page help you?