API Reference

View available slots

get
https://nexhealth.info/available_slots

This endpoint returns the bookable slots for the requested locations over the given date range, computed from provider availabilities and existing appointments. At least one of pids or appointment_type_id must be provided.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

Use smaller number of days for better performance

Response time increases when requesting a large number of days. For better performance, request a smaller number of days and leverage the next_available_date field if no slots are found.

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. For best performance, this value should not exceed 14 days.

int32

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

int32

Filter by specific working hour label

string
enum

Filter by source of working hours

Allowed:
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

int32
1 to 5
Defaults to 1

Number of appointments (default:1, max:5) that can be booked in a single slot. Only supported for eClinicalWorks and NextGen.

lids[]
array of int32s
required

Array of Location Ids

lids[]*
pids[]
array of int32s

Array of Provider Ids

pids[]
operatory_ids[]
array of int32s

Specify this if booking is mapped to operatory in this location

operatory_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?