View appointments

get

https://nexhealth.info/appointments

This endpoint returns appointments overlapping with the given start/end time window for the location specified by location_id under the institution specified by the subdomain parameter. Related resources can be included via include[]; patient is included by default. Deleted appointments are always excluded from the results.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

subdomain

string

required

Used to scope the request to the specified institution

location_id

int32

required

Used to scope the request to the specified location

start

date-time

required

A parseable date string defining the earliest returned records. Recommended format is YYYY-MM-DDThh:mm:ss+0000

end

date-time

required

A parseable date string defining the last returned records. Recommended format is YYYY-MM-DDThh:mm:ss+0000

timezone

string

Timezone for the appointment clinic

cancelled

boolean

Is appointment cancelled

unavailable

boolean

Unavailable appointments are used to block availability on a schedule, specify to set the filter

nex_only

boolean

Only show appointments booked via NexHealth API

updated_since

date-time

Query appointments whose records have updated since the specified datetime in ISO8601 format. Must be a parseable date/time, recommended formats are YYYY-MM-DD or YYYY-MM-DDT00:00:00+0000

appointment_type_id

int32

Get appointments for a specific appointment type

foreign_id

string

Unique appointment id from the EHR

patient_id

int32

Get appointments for a specific patient

created_by

int32

Query appointments that were created by a specific user

page

int32

Defaults to 1

Page number. Starts with page 1

per_page

int32

Defaults to 5

Number of results to return per page. Defaults is 5 per page and Max 300 per page

provider_ids[]

array of int32s

Query appointments that are booked with the specified providers only

provider_ids[]

operatory_ids[]

array of int32s

Query appointments that are booked in the specified operatories only

operatory_ids[]

include[]

array of strings

Resources to be included in the response

include[]

Allowed:

Headers

Nex-Api-Version

string

required

Defaults to v2

The NexHealth API version

Responses

200Successful

400Bad Request

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error