View available slots (beta)

get

https://nexhealth.info/available_slots

🚧
Beta
Send Nex-Api-Version: v3.1.0 to use this endpoint. It is still changing, and access is limited to approved partner institutions. Contact NexHealth before you build on it.

Changed from v3.0.0: Adds query param only_active_providers; changes query param slot_interval; adds response fields data[].slots[].appointment_type_id, data[].slots[].schedule_template_id, data[].slots[].working_hour_id.

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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

subdomain

string

required

Used to scope the request to the specified institution

start_date

date

required

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

days

int32

required

Number of days to include, counting the start date. For best performance, this value should not exceed 14 days.

appointment_type_id

int32

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

working_hour_label_id

int32

Filter by specific working hour label

working_hour_source

string

enum

Filter by source of working hours

Allowed:

slot_length

int32

Manually specify slot length in minutes. Defaults to 15 minutes

slot_interval

int32

≥ 1

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

overlapping_operatory_slots

boolean

Defaults to false

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

only_active_providers

boolean

Defaults to false

Only return availabilities for active providers, omitting slots for providers marked as inactive. Default is false

appointments_per_timeslot

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

Nex-Api-Version

string

required

Defaults to v3.1.0

The NexHealth API version

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful

400Bad Request

401Unauthorized

403Forbidden

500Internal Server Error