Get available time slots for an event type

GET/v2/slots

Query Parameters

bookingUidToReschedulestring

The unique identifier of the booking being rescheduled. When provided will ensure that the original booking time appears within the returned available slots when rescheduling.

startRequiredstring

  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.

endRequiredstring

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.

organizationSlugstring

The slug of the organization to which user with username belongs or team with teamSlug belongs.

teamSlugstring

The slug of the team who owns event type with eventTypeSlug - used when slots are checked for team event type.

usernamestring

The username of the user who owns event type with eventTypeSlug - used when slots are checked for individual user event type.

eventTypeSlugstring

The slug of the event type for which available slots should be checked. If slug is provided then username or teamSlug must be provided too and if relevant organizationSlug too.

eventTypeIdnumber

The ID of the event type for which available slots should be checked.

usernamesstring

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.

formatstring

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.

durationnumber

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.

timeZonestring

Time zone in which the available slots should be returned. Defaults to UTC.

Header Parameters

ical-api-versionRequiredstring

Must be set to 2024-09-04. If not set to this value, the endpoint will default to an older version.

Default: "2024-09-04"

curl -X GET "https://example.com/v2/slots?bookingUidToReschedule=abc123def456&start=2050-09-05&end=2050-09-06&organizationSlug=org-slug&teamSlug=team-slug&username=bob&eventTypeSlug=event-type-slug&eventTypeId=100&usernames=alice%2Cbob&format=range&duration=60&timeZone=Europe%2FRome" \
  -H "ical-api-version: 2024-09-04"

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 field will be an empty object {}.

{
  "status": "success",
  "data": {
    "2050-09-05": [
      {
        "start": "2050-09-05T09:00:00.000+02:00"
      },
      {
        "start": "2050-09-05T10:00:00.000+02:00"
      }
    ],
    "2050-09-06": [
      {
        "start": "2050-09-06T09:00:00.000+02:00"
      },
      {
        "start": "2050-09-06T10:00:00.000+02:00"
      }
    ]
  }
}

GETGet available time slots for an event type

Query Parameters

Header Parameters

Response