Get Free Slots

GET 
/calendars/:calendarId/free-slots

Get free slots for a calendar between a date range. Optionally a consumer can also request free slots in a particular timezone and also for a particular user.

Request

Version stringrequired

API Version

Available optionsv3

calendarId stringrequired

Calendar Id

startDate numberrequired

Start Date (⚠️ Important: Date range cannot be more than 31 days)

endDate numberrequired

End Date (⚠️ Important: Date range cannot be more than 31 days)

timezone string

The timezone in which the free slots are returned

userId string

The user for whom the free slots are returned

userIds string[]

The users for whom the free slots are returned

application/json

Availability map keyed by date (YYYY-MM-DD)

application/json

Schema

Schema

property name*SlotsSchema

Example (auto)

{
  "2024-10-28": {
    "slots": [
      "2024-10-28T10:00:00-05:00",
      "2024-10-28T11:00:00-05:00"
    ]
  },
  "2024-10-29": {
    "slots": [
      "2024-10-29T10:00:00-05:00",
      "2024-10-29T14:30:00-05:00"
    ]
  }
}