Endpoints

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 params location_id[], only_active_providers, operatory_id[], provider_id[] (+1 more); removes query params lids[], operatory_ids[], pids[]; changes query param slot_interval; and other schema changes.

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 provider_id or appointment_type_id must be provided.

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

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.

int64

Only consider working hours that belong to this schedule template

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
ā‰„ 1

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

boolean
Defaults to false

Only return availabilities for active providers, omitting slots for providers marked as inactive. 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 athenahealth, eClinicalWorks, ModMed and NextGen.

location_id[]
array of int32s

NexHealth IDs of the locations

location_id[]
provider_id[]
array of int32s

NexHealth IDs of the providers

provider_id[]
operatory_id[]
array of int32s

NexHealth IDs of the operatories. Specify this if booking is mapped to operatory in this location

operatory_id[]
Headers
string
required
Defaults to v3.1.0

The NexHealth API version

Responses

Updated 20 days 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 20 days ago

Did this page help you?
ChangelogMCP serverErrorsdevelopers@nexhealth.com