Getting Started
Platform / Cal Provider
Platform / Google Calendar
Platform / Managed Users
Platform / Webhooks
Orgs / Attributes
Orgs / Attributes / Options
Orgs / Event Types
Orgs / Memberships
Orgs / Schedules
Orgs / Teams
Orgs / Teams / Memberships
Orgs / Teams / Schedules
Orgs / Webhooks
Bookings
- GETGet all bookings
- POSTCreate a booking
- GETGet a booking
- POSTReschedule a booking
- POSTCancel a booking
- POSTMark a booking absence
- POSTAutomatically reassign booking to a new host
- POSTReassign a booking to a specific user
- POSTConfirm booking that requires a confirmation
- POSTDecline booking that requires a confirmation
Calendars
Conferencing
Destination Calendars
Event Types
Event Types / Webhooks
Schedules
Selected Calendars
Stripe
Teams / Event Types
Teams / Memberships
Timezones
Get all event types
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Must be set to 2024-06-14
The username of the user to get event types for. If only username provided will get all event types.
Slug of event type to return. Notably, if eventSlug is provided then username must be provided too, because multiple users can have event with same slug.
Get dynamic event type for multiple usernames separated by comma. e.g usernames=alice,bob
slug of the user's organization if he is in one, orgId is not required if using this parameter
ID of the organization of the user you want the get the event-types of, orgSlug is not needed when using this parameter
Headers
Must be set to 2024-06-14
Query Parameters
The username of the user to get event types for. If only username provided will get all event types.
Slug of event type to return. Notably, if eventSlug is provided then username must be provided too, because multiple users can have event with same slug.
Get dynamic event type for multiple usernames separated by comma. e.g usernames=alice,bob
slug of the user's organization if he is in one, orgId is not required if using this parameter
ID of the organization of the user you want the get the event-types of, orgSlug is not needed when using this parameter
Response
success
, error
If you want that user can choose between different lengths of the event you can specify them here. Must include the provided lengthInMinutes
.
only allowed value for type is name
name
, email
, phone
, address
, text
, number
, textarea
, select
, multiselect
, multiemail
, checkbox
, radio
, boolean
Disable this booking field if the URL contains query parameter with key equal to the slug and prefill it with the provided value. For example, if URL contains query parameter &name=bob
, the name field will be prefilled with this value and disabled.
This property is always true because it's a default field
Limit how far in the future this event can be booked
Whether the window should be business days, calendar days or a range of dates
businessDays
, calendarDays
, range
How many business day into the future can this event be booked
Determines the behavior of the booking window:
- If **true**, the window is rolling. This means the number of available days will always be equal the specified 'value'
and adjust dynamically as bookings are made. For example, if 'value' is 3 and availability is only on Mondays,
a booker attempting to schedule on November 10 will see slots on November 11, 18, and 25. As one of these days
becomes fully booked, a new day (e.g., December 2) will open up to ensure 3 available days are always visible.
- If **false**, the window is fixed. This means the booking window only considers the next 'value' days from the
moment someone is trying to book. For example, if 'value' is 3, availability is only on Mondays, and the current
date is November 10, the booker will only see slots on November 11 because the window is restricted to the next
3 calendar days (November 10–12).
The integration type of the destination calendar. Refer to the /api/v2/calendars endpoint to retrieve the integration type of your connected calendars.
The external ID of the destination calendar. Refer to the /api/v2/calendars endpoint to retrieve the external IDs of your connected calendars.
Was this page helpful?