Skip to main content
GET
List available slots
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key
string
required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Path Parameters

meeting_sid
string
required

The unique identifier (SID) of the scheduling link. You can get sid in different ways. Visit the scheduling link page and then click on "Settings" > "Show SID". That will give you sid. You can also get this from the response of the List scheduling links endpoint.

Example:

"vj5pgkh"

Query Parameters

time_zone
string
required

Time zone in which to check available slots.

Example:

"Asia/Kolkata"

year
string
required

Year for which to check available slots.

Example:

"2025"

month
string
required

Month for which to check available slots.

Example:

"11"

day
string

The day of the month to check for available slots. If omitted, slots for all days in the month will be returned. If provided, only slots for the specified day will be included.

Example:

"21"

add_on_service_ids[]
string[]

IDs of the add-on services the person intends to book. Slots are sized for the scheduling link's duration plus the duration of these add-on services. Pass the same IDs to Create a booking. Returns a 422 error if an ID does not belong to the scheduling link, or if more than one is passed while allow_multiple_add_on_services is false.

Example:
duration
integer

Slot length in minutes. Must be one of the durations the scheduling link offers. Defaults to its default duration.

Example:

60

host_email
string

To get the slots of a particular host only, for scheduling links with more than one host. The email must belong to one of the scheduling link's hosts, otherwise the request is rejected with a 422 error.

Example:

"oliver@example.com"

override_availability
boolean
default:false

When true, lists every future time instead of only the available ones. Each slot then includes is_available and already_overridden, and count is left out.

Example:

true

Response

OK - Request succeeded

slots
object[]