CalendarsVersion: v3

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. The response is keyed by date (YYYY-MM-DD). A date with no free slots (closed, blocked or fully booked) is left out of the response.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:calendars.readonly

Auth methods:OAuthPrivate Integration

Token type:Sub-Account Token

Request

Headers

Versionstringrequired

API Version

Available optionsv3

Example:v3

Path Parameters

calendarIdstringrequired

Calendar Id

Example:ocQHyuzHvysMo5N5VsXc

Query Parameters

startDatenumberrequired

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

Example:1548898600000

endDatenumberrequired

End Date (⚠️ Important: Date range cannot be more than 31 days). Exclusive: the range ends just before this time. To include a whole day, end at the start of the next day (for Nov 9 only: startDate = Nov 9 00:00, endDate = Nov 10 00:00, both in epoch milliseconds).

Example:1601490599999

timezonestring

The timezone in which the free slots are returned

Example:America/Chihuahua

userIdstring

The user for whom the free slots are returned

Example:082goXVW3lIExEQPOnd3

userIdsstring[]

The users for whom the free slots are returned

Example:["082goXVW3lIExEQPOnd3"]

durationnumber

Duration in minutes to use for slot calculation. Must match one of the active durationOptions on the calendar. If omitted, the default duration is used.

Example:30

Response

application/json

Availability map keyed by date (YYYY-MM-DD). Dates with no free slots are left out.

property name*SlotsSchema