API Reference

View appointments

get
https://nexhealth.info/appointments
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

int32
required

Used to scope the request to the specified location

date-time
required

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

date-time
required

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

string

Timezone for the appointment clinic

boolean

Is appointment cancelled

boolean

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

boolean

Only show appointments booked via NexHealth API

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

int32

Get appointments for a specific appointment type

string

Unique appointment id from the EMR

int32

Get appointments for a specific patient

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[]
int32

Query appointments that were created by a specific user

include[]
array of strings

Resources to be included in the response

include[]
int32
Defaults to 1

Page number. Starts with page 1

int32
Defaults to 5

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

Responses

Updated 9 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.Nexhealth+json;version=2

Updated 9 days ago