Get available time slots for an event type
There are 4 ways to get available slots for event type of an individual user:
-
By event type id. Event type id can be of user and team event types. Example ‘/v2/slots?eventTypeId=10&start=2050-09-05&end=2050-09-06&timeZone=Europe/Rome’
-
By event type slug + username. Example ‘/v2/slots?eventTypeSlug=intro&username=bob&start=2050-09-05&end=2050-09-06’
-
By event type slug + username + organization slug when searching within an organization. Example ‘/v2/slots?organizationSlug=org-slug&eventTypeSlug=intro&username=bob&start=2050-09-05&end=2050-09-06’
-
By usernames only (used for dynamic event type - there is no specific event but you want to know when 2 or more people are available). Example ‘/v2/slots?usernames=alice,bob&username=bob&organizationSlug=org-slug&start=2050-09-05&end=2050-09-06’. As you see you also need to provide the slug of the organization to which each user in the ‘usernames’ array belongs.
And 3 ways to get available slots for team event type:
-
By team event type id. Example ‘/v2/slots?eventTypeId=10&start=2050-09-05&end=2050-09-06&timeZone=Europe/Rome’
-
By team event type slug + team slug. Example ‘/v2/slots?eventTypeSlug=intro&teamSlug=team-slug&start=2050-09-05&end=2050-09-06’
-
By team event type slug + team slug + organization slug when searching within an organization. Example ‘/v2/slots?organizationSlug=org-slug&eventTypeSlug=intro&teamSlug=team-slug&start=2050-09-05&end=2050-09-06’
All of them require “start” and “end” query parameters which define the time range for which available slots should be checked. Optional parameters are:
- timeZone: Time zone in which the available slots should be returned. Defaults to UTC.
- duration: Only use for event types that allow multiple durations or for dynamic event types. If not passed for multiple duration event types defaults to default duration. For dynamic event types defaults to 30 aka each returned slot is 30 minutes long. So duration=60 means that returned slots will be each 60 minutes long.
- format: Format of the slots. By default return is an object where each key is date and value is array of slots as string. If you want to get start and end of each slot use “range” as value.
- bookingUidToReschedule: When rescheduling an existing booking, provide the booking’s unique identifier to exclude its time slot from busy time calculations. This ensures the original booking time appears as available for rescheduling.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Must be set to 2024-09-04. If not set to this value, the endpoint will default to an older version.
Query Parameters
Response
A map of available slots indexed by date, where each date is associated with an array of time slots. If format=range is specified, each slot will be an object with start and end properties denoting start and end of the slot. For seated slots each object will have attendeesCount and bookingUid properties. If no slots are available, the data object will be empty {}.
- Default format (or with format=time)
- Range format (when format=range)