Available slots

Available slots returns valid start times for booking an appointment. It requires a subdomain. It accepts an array of location IDs (lids) and an array of provider IDs (pids), so you can get slots for more than one location and provider in one request.

📘

Multiple operatories

If the same time slot is open in more than one operatory, the response returns it once.

👍

next_available_date

If the request finds no slots, next_available_date holds the next day with valid slots. If there are no valid slots within 180 days, this field is null.

🚧

Request fewer days for faster responses

Response time goes up when you request many days. Request fewer days, and use the next_available_date field when a request finds no slots.

Slot length and slot interval

Slot length is the length of the opening you want start times for. By default, the endpoint returns start times for a 15 minute appointment. Change this with the slot_length parameter. If you send an appointment_type_id, slot_length is set to that appointment type's minutes.

If you send both appointment_type_id and slot_length, the appointment type's length takes precedence over slot_length.

Slot interval is how often a start time is checked. By default, the interval matches slot_length in minutes. If slot_length is 60 minutes, start times come back in 60 minute steps, even if you could book an appointment 5 minutes after a returned slot. Change this with the slot_interval parameter.

📘

Time zones

The endpoint reads and returns slot times in the location's local time zone.

Available slots response

{
  "code": true,
  "description": [
    [
      "Description"
    ]
  ],
  "error": [
    [
      "Error"
    ]
  ],
  "data": [
    {
      "lid": 1,
      "pid": 83,
      "operatory_id": 54,
      "slots": [
        {
          "time": "2017-10-09T07:00:00.000-04:00",
          "operatory_id": 54,
          "provider_id": 83
        }
      ]
    }
  ],
  "count": 1
}