Overview
The Schedule object is at the core of our Availability and Scheduling APIs. A Schedule represents a specific practitioner, practicing location, and appointment type. Each schedule maintains a list of insurances that it accepts and available (or open) slots (available through the /appointments/{appointment_id}/slots endpoint).
Insurances
The standard index returns the insurances accepted at a location on best effort, and we cannot guarantee this information is up-to-date. Instead, we suggest you use other data sources to retrieve insurance information and update the Schedule object on a custom index version to save that information. Contact us at [email protected] for recommendations on data providers.
Scheduling method
Each schedule also defines the scheduling method it supports. Scheduling methods are defined as follows.
| Scheduling Method | Description |
|---|---|
direct_api | The schedule exposes open/available slots and appointments can be booked immediately through an API call. |
open_slots_only | This schedule exposes open/available slots, but appointments cannot be booked through our APIs. |
null | This schedule does not expose open/available slots and appointments cannot be booked through our APIs. |
Index Version support
By default, our API returns the schedules we expose appointment booking capabilities for and the best-effort data collected on each. This is accessible using the idx_standard index.
However, this data is complex and subject to change; for example, the insurances accepted at a specific location by a practitioner can often change. We recommend using external data vendors to retrieve this data and then save this data in your index version.
Use the Closure-Index-Version header to specify which Index Version you want to write to and read from.