API Reference

View appointment slots

Log in to see full request history
Query Params
string
required

Used to scope the request to the specified institution

date
required

Date string you want results to start at, format YYYY-MM-DD

int32
required

Number of days to include, counting the start date

lids[]
array of int32s
required

Array of Location Ids

lids[]*
pids[]
array of int32s
required

Array of Provider Ids

pids[]*
operatory_ids[]
array of int32s

Specify this if booking is mapped to operatory in this location

operatory_ids[]
int32

Specify an appointment type to filter returned slots and set slot_length to appointment_type.minutes

int32

Manually specify slot length in minutes. Defaults to 15 minutes

int32

Manually specify the time in minutes between returned slot start times when a contiguous opening exists longer than the slot_length

boolean
Defaults to false

Return all available slots for operatories at a given time instead of returning only the first found. Default is false

Responses

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