Find out when is an event type ready to be booked.
There are 4 ways to get available slots:
-
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.
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.
- slotFormat: 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.
Headers
Must be set to 2024-09-04
Query Parameters
Time starting from which available slots should be checked.
Must be in UTC timezone as ISO 8601 datestring.
You can pass date without hours which defaults to start of day or specify hours:
2024-08-13 (will have hours 00:00:00 aka at very beginning of the date) or you can specify hours manually like 2024-08-13T09:00:00Z.
Time until which available slots should be checked.
Must be in UTC timezone as ISO 8601 datestring.
You can pass date without hours which defaults to end of day or specify hours:
2024-08-20 (will have hours 23:59:59 aka at the very end of the date) or you can specify hours manually like 2024-08-20T18:00:00Z.
The username of the user to get event types for.
The slug of the event type for which available slots should be checked. If slug is provided then username must be provided too.
The ID of the event type for which available slots should be checked.
The usernames for which available slots should be checked separated by a comma.
Checking slots by usernames is used mainly for dynamic events where there is no specific event but we just want to know when 2 or more people are available.
Must contain at least 2 usernames.
Format of slot times in response. Use 'range' to get start and end times. Use 'time' or omit this query parameter to get only start time.
If event type has multiple possible durations then you can specify the desired duration here. Also, if you are fetching slots for a dynamic event then you can specify the duration her which defaults to 30, meaning that returned slots will be each 30 minutes long.
Time zone in which the available slots should be returned. Defaults to UTC.
Response
Was this page helpful?