{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.
Body
Slug of scheduling link you want to book.
"meeting-with-oliver-smith"
Name of person making the booking.
"Eve Smith"
Email of person making the booking.
"eve@example.com"
Time zone of person making the booking.
"Asia/Kolkata"
Date on which you want to book. This should be in "YYYY-MM-DD" format. If slot_date
and slot_start_time
are not provided then the first available slot will be booked.
"2025-07-15"
Start time for the booking. This should be in "HH:MM AM/PM" format.
"01:30 PM"
Your preferred meeting spot. This field is optional. Before passing this value, ensure that the corresponding meeting spot is configured in the "Where" section of the scheduling link.
custom
, jitsi
, in_person
, daily
, zoom
, whereby
, google_meet
, teams
"jitsi"
Responses for the questions of booking form (optional). The key of the field should be the field code of the question. The field code can be found in scheduling link's Settings -> Questions -> 3 dot menu of the question -> Edit -> Advanced properties. You can specify guest emails using the guest_email_s
field code.
{
"guest_email_s": ["sam@example.com", "charlie@example.com"],
"language": "English"
}
Response
OK - Request succeeded
Unique identifier for the booking.
Short identifier (SID) for the booking, used in URLs and API calls.
Reference to the parent booking if this is a group booking.
Email address of the person who made the booking.
Name of the person who made the booking.
Name of the primary host for the meeting.
Email address of the primary host for the meeting.
Whether the meeting has multiple hosts.
List of all hosts for the meeting when is_multihost is true.
Start time of the booking in UTC.
End time of the booking in UTC.
Time zone of the booking location.
Start time of the booking in the client's local time zone.
End time of the booking in the client's local time zone.
Current status of the booking (e.g., confirmed, cancelled, awaiting_approval, rejected).
Reason provided when the booking was cancelled.
Name of the person who cancelled the booking.
Whether a reschedule has been requested for this booking.
Preferred meeting platform or location type selected by the client.
Type of meeting room or platform being used.
daily
, zoom
, jitsi
, google_meet
, teams
, whereby
, in_person
, custom
, phone_call
URL for the meeting room or platform.
Unique identifier for the meeting room or platform.
Additional details about the meeting location or platform.
Timestamp when the booking was created.
Timestamp when the booking was last updated.
Unique identifier of the scheduling link this booking belongs to.
Basic information about the associated meeting.
Whether the booking is marked as no-show by the host.
Outcome status of the meeting.
URL to access notes or additional information about the booking.
Internal notes about the booking visible only to hosts and admins.
Additional custom data associated with the booking.
URL for hosts and admins to view and manage the booking.
URL for clients to view their booking details.
Responses submitted through the booking form.
Form responses organized as key-value pairs for easier access.