{your-workspace}
with your workspace’s subdomain. Learn how to find your subdomain in Identifying your subdomain.
Headers
X-Api-Key is used to authenticate requests using an API key. Provide your API key in this header to access protected endpoints. Refer to Authentication for more information.
Query Parameters
Retrieve paginated results by specifying the desired page number. If this parameter is absent, all results will be returned.
Set the number of results returned in the response. Defaulting to 30 when omitted.
To get the scheduling links of a particular host only.
Response
OK - Request succeeded
List of meetings/scheduling links.
Hide child attributes
Hide child attributes
Unique identifier for the scheduling link.
Short identifier (SID) for the meeting, used in URLs and API calls.
Display name of the scheduling link.
URL-friendly identifier for the meeting, used in public scheduling links.
Detailed description of the meeting purpose or agenda.
Type of meeting. one_on_one for individual meetings, round_robin for rotating hosts, multihost for multiple simultaneous hosts, grouped for group sessions.
one_on_one
, round_robin
, multihost
, grouped
Duration of the meeting in minutes.
Whether the scheduling link is currently disabled and not accepting bookings.
Meeting platform or location type for the scheduled meeting.
custom
, jitsi
, google_meet
, daily
, zoom
, whereby
, teams
, phone_call
, in_person
Physical location details when spot is set to in_person.
Custom meeting instructions or details when spot is set to custom.
Phone number for the meeting when spot is set to phone_call.
Whether this meeting is a template that can be used to create other meetings.
How the scheduling range is calculated - by days into future, business days, or specific date range.
number_of_days_into_the_future
, number_of_business_days_into_the_future
, date_range
Value for the scheduling range (e.g., number of days or date range).
Minimum advance notice required for booking in minutes.
Time increment in minutes for available booking slots (e.g., 30 for 30-minute slots).
Timestamp when the meeting was created.
"2025-12-23T05:05:27.037Z"
Timestamp when the meeting was last updated.
"2025-03-31T13:22:19.832Z"
Timestamp when the meeting was deleted (soft delete).
null
Whether users can select from multiple meeting platforms/locations.
Whether users can select from multiple meeting duration options.
Whether conditional pricing rules are applied to this meeting.
Whether email reminders are sent for this meeting.
Whether SMS reminders are sent for this meeting.
Unique identifier of the organization that owns this meeting.
Minimum advance notice required for rescheduling in minutes.
Minimum advance notice required for cancellation in minutes.
Whether users are allowed to modify their bookings after creation.
Custom message shown when cancellation is attempted too late.
Policy text explaining cancellation terms and conditions.
Custom message shown when rescheduling is attempted too late.
Whether users can book meetings in advance beyond the normal scheduling range.
Whether to show the original price alongside any discounted price.
Original price of the meeting before any discounts.
Additional fees or charges associated with the meeting.
List of available duration options in minutes when multiple durations are allowed.
Hide child attributes
Hide child attributes
Unique identifier for the duration option.
"4ece6b6b-4b5f-4c15-9122-a85af189198c"
Duration in minutes.
30
Whether this duration is the default option.
false
Timestamp when the duration option was created.
"2025-08-18T07:43:16.775Z"
Timestamp when the duration option was last updated.
"2025-08-18T08:03:58.019Z"
Hide child attributes
Hide child attributes
Unique identifier for the spot option.
"bcc90342-9345-4d89-9144-d25d7c7b3521"
The spot type for the meeting.
daily
, zoom
, jitsi
, google_meet
, teams
, whereby
, in_person
, custom
, phone_call
"jitsi"
Whether this spot is the default option.
false
Phone number for phone call spots. Only populated when spot type is "phone_call", otherwise null.
null
Location details for in-person meetings. Only populated when spot type is "in_person", otherwise null.
null
Custom text for custom spots. Only populated when spot type is "custom", otherwise null.
null
Timestamp when the spot option was created.
"2025-08-18T07:19:28.341Z"
Timestamp when the spot option was last updated.
"2025-08-18T07:35:32.822Z"