Skip to main content
Server path: /cal-bookings | Type: Application | PCID required: Yes

Tools


cal_bookings_controller_2024_08_13_cancel_booking

Cancel a booking Parameters:
ParameterTypeRequiredDefaultDescription
bookingUidstringYesbookingUid
bodyobjectYesAccepts different types of cancel booking input: Cancel Booking (Option 1 which is for normal or recurring bookings) or Cancel Seated Booking (Option 2 which is for seated bookings)

cal_bookings_controller_2024_08_13_confirm_booking

Confirm a booking Parameters:
ParameterTypeRequiredDefaultDescription
bookingUidstringYesbookingUid

cal_bookings_controller_2024_08_13_create_booking

Create a booking Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectYesAccepts different types of booking input: Create Booking (Option 1), Create Instant Booking (Option 2), or Create Recurring Booking (Option 3)

cal_bookings_controller_2024_08_13_decline_booking

Decline a booking Parameters:
ParameterTypeRequiredDefaultDescription
bookingUidstringYesbookingUid
reasonstringNoReason for declining a booking that requires a confirmation

cal_bookings_controller_2024_08_13_get_booking

Get a booking Parameters:
ParameterTypeRequiredDefaultDescription
bookingUidstringYesbookingUid

cal_bookings_controller_2024_08_13_get_bookings

Get all bookings Parameters:
ParameterTypeRequiredDefaultDescription
statusany[]NoFilter bookings by status. If you want to filter by multiple statuses, separate them with a comma.
attendeeEmailstringNoFilter bookings by the attendee’s email address.
attendeeNamestringNoFilter bookings by the attendee’s name.
bookingUidstringNoFilter bookings by the booking Uid.
eventTypeIdsstringNoFilter bookings by event type ids belonging to the user. Event type ids must be separated by a comma.
eventTypeIdstringNoFilter bookings by event type id belonging to the user.
teamsIdsstringNoFilter bookings by team ids that user is part of. Team ids must be separated by a comma.
teamIdstringNoFilter bookings by team id that user is part of
afterStartstringNoFilter bookings with start after this date string.
beforeEndstringNoFilter bookings with end before this date string.
afterCreatedAtstringNoFilter bookings that have been created after this date string.
beforeCreatedAtstringNoFilter bookings that have been created before this date string.
afterUpdatedAtstringNoFilter bookings that have been updated after this date string.
beforeUpdatedAtstringNoFilter bookings that have been updated before this date string.
sortStartstringNoSort results by their start time in ascending or descending order.
sortEndstringNoSort results by their end time in ascending or descending order.
sortCreatedstringNoSort results by their creation time (when booking was made) in ascending or descending order.
sortUpdatedAtstringNoSort results by their updated time (for example when booking status changes) in ascending or descending order.
takenumberNoThe number of items to return
skipnumberNoThe number of items to skip

Get ‘Add to Calendar’ links for a booking Parameters:
ParameterTypeRequiredDefaultDescription
bookingUidstringYesbookingUid

cal_bookings_controller_2024_08_13_mark_no_show

Mark a booking absence Parameters:
ParameterTypeRequiredDefaultDescription
bookingUidstringYesbookingUid
attendeesany[]Noattendees
hostbooleanNoWhether the host was absent

cal_bookings_controller_2024_08_13_reassign_booking

Reassign a booking to auto-selected host Parameters:
ParameterTypeRequiredDefaultDescription
bookingUidstringYesbookingUid

cal_bookings_controller_2024_08_13_reassign_booking_to_user

Reassign a booking to a specific host Parameters:
ParameterTypeRequiredDefaultDescription
bookingUidstringYesbookingUid
userIdnumberYesuserId
reasonstringNoReason for reassigning the booking

cal_bookings_controller_2024_08_13_reschedule_booking

Reschedule a booking Parameters:
ParameterTypeRequiredDefaultDescription
bookingUidstringYesbookingUid
bodyobjectYesAccepts different types of reschedule booking input: Reschedule Booking (Option 1) or Reschedule Seated Booking (Option 2). If you’re rescheduling a seated booking as org admin of booking host, pass booking input for Reschedule Booking (Option 1) along with your access token in the request header. If you are rescheduling a seated booking for an event type with ‘show attendees’ disabled, then to retrieve attendees in the response either set ‘show attendees’ to true on event type level or you have to provide an authentication method of event type owner, host, team admin or owner or org admin or owner.