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

Tools

ToolDescription
cal_calendars_conferencing_controller_connectConnect your conferencing application
cal_calendars_conferencing_controller_defaultSet your default conferencing application
cal_calendars_conferencing_controller_disconnectDisconnect your conferencing application
cal_calendars_conferencing_controller_get_defaultGet your default conferencing application
cal_calendars_conferencing_controller_list_installed_conferencing_appsList your conferencing applications
cal_calendars_conferencing_controller_redirectGet OAuth conferencing app auth URL
cal_calendars_conferencing_controller_saveConferencing app OAuth callback
cal_calendars_controller_checkCheck a calendar connection
cal_calendars_controller_check_ics_feedCheck an ICS feed
cal_calendars_controller_create_ics_feedSave an ICS feed
cal_calendars_controller_delete_calendar_credentialsDisconnect a calendar
cal_calendars_controller_get_busy_timesGet busy times
cal_calendars_controller_get_calendarsGet all calendars
cal_calendars_controller_redirectGet OAuth connect URL
cal_calendars_controller_saveSave Google or Outlook calendar credentials
cal_calendars_controller_sync_credentialsSave Apple calendar credentials
cal_calendars_destination_calendars_controller_update_destination_calendarsUpdate destination calendars
cal_calendars_schedules_controller_2024_06_11_create_scheduleCreate a schedule
cal_calendars_schedules_controller_2024_06_11_delete_scheduleDelete a schedule
cal_calendars_schedules_controller_2024_06_11_get_default_scheduleGet default schedule
cal_calendars_schedules_controller_2024_06_11_get_scheduleGet a schedule
cal_calendars_schedules_controller_2024_06_11_get_schedulesGet all schedules
cal_calendars_schedules_controller_2024_06_11_update_scheduleUpdate a schedule
cal_calendars_selected_calendars_controller_add_selected_calendarAdd a selected calendar
cal_calendars_selected_calendars_controller_delete_selected_calendarDelete a selected calendar
cal_calendars_slots_controller_2024_09_04_delete_reserved_slotDelete a reserved slot
cal_calendars_slots_controller_2024_09_04_get_available_slotsGet available time slots for an event type
cal_calendars_slots_controller_2024_09_04_get_reserved_slotGet reserved slot
cal_calendars_slots_controller_2024_09_04_reserve_slotReserve a slot
cal_calendars_slots_controller_2024_09_04_update_reserved_slotUpdate a reserved slot

cal_calendars_conferencing_controller_connect

Connect your conferencing application Parameters:
ParameterTypeRequiredDefaultDescription
appstringYesConferencing application type

cal_calendars_conferencing_controller_default

Set your default conferencing application Parameters:
ParameterTypeRequiredDefaultDescription
appstringYesConferencing application type

cal_calendars_conferencing_controller_disconnect

Disconnect your conferencing application Parameters:
ParameterTypeRequiredDefaultDescription
appstringYesConferencing application type

cal_calendars_conferencing_controller_get_default

Get your default conferencing application

cal_calendars_conferencing_controller_list_installed_conferencing_apps

List your conferencing applications

cal_calendars_conferencing_controller_redirect

Get OAuth conferencing app auth URL Parameters:
ParameterTypeRequiredDefaultDescription
appstringYesConferencing application type
returnTostringYesreturnTo
onErrorReturnTostringYesonErrorReturnTo

cal_calendars_conferencing_controller_save

Conferencing app OAuth callback Parameters:
ParameterTypeRequiredDefaultDescription
statestringYesstate
appstringYesConferencing application type
codestringYescode

cal_calendars_controller_check

Check a calendar connection Parameters:
ParameterTypeRequiredDefaultDescription
calendarstringYescalendar

cal_calendars_controller_check_ics_feed

Check an ICS feed

cal_calendars_controller_create_ics_feed

Save an ICS feed Parameters:
ParameterTypeRequiredDefaultDescription
readOnlybooleanNoWhether to allowing writing to the calendar or not
urlsany[]YesAn array of ICS URLs

cal_calendars_controller_delete_calendar_credentials

Disconnect a calendar Parameters:
ParameterTypeRequiredDefaultDescription
calendarstringYescalendar
idintegerYesCredential ID of the calendar to delete, as returned by the /calendars endpoint

cal_calendars_controller_get_busy_times

Get busy times Parameters:
ParameterTypeRequiredDefaultDescription
loggedInUsersTzstringNoDeprecated: Use timeZone instead. The timezone of the user represented as a string
timeZonestringNoThe timezone for the busy times query represented as a string
dateFromstringNoThe starting date for the busy times query
dateTostringNoThe ending date for the busy times query
credentialIdnumberYescredentialId
externalIdstringYesexternalId

cal_calendars_controller_get_calendars

Get all calendars

cal_calendars_controller_redirect

Get OAuth connect URL Parameters:
ParameterTypeRequiredDefaultDescription
calendarstringYescalendar
isDryRunbooleanYesisDryRun
redirstringNoRedirect URL after successful calendar authorization.

cal_calendars_controller_save

Save Google or Outlook calendar credentials Parameters:
ParameterTypeRequiredDefaultDescription
statestringYesstate
codestringYescode
calendarstringYescalendar

cal_calendars_controller_sync_credentials

Save Apple calendar credentials Parameters:
ParameterTypeRequiredDefaultDescription
calendarstringYescalendar
passwordstringYespassword
usernamestringYesusername

cal_calendars_destination_calendars_controller_update_destination_calendars

Update destination calendars Parameters:
ParameterTypeRequiredDefaultDescription
delegationCredentialIdstringNodelegationCredentialId
externalIdstringYesUnique identifier used to represent the specific calendar, as returned by the /calendars endpoint
integrationstringYesThe calendar service you want to integrate, as returned by the /calendars endpoint

cal_calendars_schedules_controller_2024_06_11_create_schedule

Create a schedule Parameters:
ParameterTypeRequiredDefaultDescription
availabilityany[]NoEach object contains days and times when the user is available. If not passed, the default availability is Monday to Friday from 09:00 to 17:00.
isDefaultbooleanYesEach user should have 1 default schedule. If you specified timeZone when creating managed user, then the default schedule will be created with that timezone. Default schedule means that if an event type is not tied to a specific schedule then the default schedule is used.
namestringYesname
overridesany[]NoNeed to change availability for a specific date? Add an override.
timeZonestringYesTimezone is used to calculate available times when an event using the schedule is booked.

cal_calendars_schedules_controller_2024_06_11_delete_schedule

Delete a schedule Parameters:
ParameterTypeRequiredDefaultDescription
scheduleIdnumberYesscheduleId

cal_calendars_schedules_controller_2024_06_11_get_default_schedule

Get default schedule

cal_calendars_schedules_controller_2024_06_11_get_schedule

Get a schedule Parameters:
ParameterTypeRequiredDefaultDescription
scheduleIdnumberYesscheduleId

cal_calendars_schedules_controller_2024_06_11_get_schedules

Get all schedules

cal_calendars_schedules_controller_2024_06_11_update_schedule

Update a schedule Parameters:
ParameterTypeRequiredDefaultDescription
scheduleIdstringYesscheduleId
availabilityany[]Noavailability
isDefaultbooleanNoisDefault
namestringNoname
overridesany[]Nooverrides
timeZonestringNotimeZone

cal_calendars_selected_calendars_controller_add_selected_calendar

Add a selected calendar Parameters:
ParameterTypeRequiredDefaultDescription
credentialIdnumberYescredentialId
delegationCredentialIdstringNodelegationCredentialId
externalIdstringYesexternalId
integrationstringYesintegration

cal_calendars_selected_calendars_controller_delete_selected_calendar

Delete a selected calendar Parameters:
ParameterTypeRequiredDefaultDescription
integrationstringYesintegration
externalIdstringYesexternalId
credentialIdstringYescredentialId
delegationCredentialIdstringNodelegationCredentialId

cal_calendars_slots_controller_2024_09_04_delete_reserved_slot

Delete a reserved slot Parameters:
ParameterTypeRequiredDefaultDescription
uidstringYesuid

cal_calendars_slots_controller_2024_09_04_get_available_slots

Get available time slots for an event type Parameters:
ParameterTypeRequiredDefaultDescription
bookingUidToReschedulestringNoThe unique identifier of the booking being rescheduled. When provided will ensure that the original booking time appears within the returned available slots when rescheduling.
startstringYesTime starting from which available slots should be checked. Must be in UTC timezone as ISO 8601 datestring. You can pass date without hours which defaults to start of day or specify hours: 2024-08-13 (will have hours 00:00:00 aka at very beginning of the date) or you can specify hours manually like 2024-08-13T09:00:00Z.
endstringYesTime until which available slots should be checked. Must be in UTC timezone as ISO 8601 datestring. You can pass date without hours which defaults to end of day or specify hours: 2024-08-20 (will have hours 23:59:59 aka at the very end of the date) or you can specify hours manually like 2024-08-20T18:00:00Z.
organizationSlugstringNoThe slug of the organization to which user with username belongs or team with teamSlug belongs.
teamSlugstringNoThe slug of the team who owns event type with eventTypeSlug - used when slots are checked for team event type.
usernamestringNoThe username of the user who owns event type with eventTypeSlug - used when slots are checked for individual user event type.
eventTypeSlugstringNoThe slug of the event type for which available slots should be checked. If slug is provided then username or teamSlug must be provided too and if relevant organizationSlug too.
eventTypeIdnumberNoThe ID of the event type for which available slots should be checked.
usernamesstringNoThe usernames for which available slots should be checked separated by a comma. Checking slots by usernames is used mainly for dynamic events where there is no specific event but we just want to know when 2 or more people are available. Must contain at least 2 usernames.
formatstringNoFormat of slot times in response. Use ‘range’ to get start and end times. Use ‘time’ or omit this query parameter to get only start time.
durationnumberNoIf event type has multiple possible durations then you can specify the desired duration here. Also, if you are fetching slots for a dynamic event then you can specify the duration her which defaults to 30, meaning that returned slots will be each 30 minutes long.
timeZonestringNoTime zone in which the available slots should be returned. Defaults to UTC.

cal_calendars_slots_controller_2024_09_04_get_reserved_slot

Get reserved slot Parameters:
ParameterTypeRequiredDefaultDescription
uidstringYesuid

cal_calendars_slots_controller_2024_09_04_reserve_slot

Reserve a slot Parameters:
ParameterTypeRequiredDefaultDescription
eventTypeIdnumberYesThe ID of the event type for which slot should be reserved.
reservationDurationnumberNoONLY for authenticated requests with api key, access token or OAuth credentials (ID + secret). For how many minutes the slot should be reserved - for this long time noone else can book this event type at start time. If not provided, defaults to 5 minutes.
slotDurationnumberNoBy default slot duration is equal to event type length, but if you want to reserve a slot for an event type that has a variable length you can specify it here as a number in minutes. If you don’t have this set explicitly that event type can have one of many lengths you can omit this.
slotStartstringYesISO 8601 datestring in UTC timezone representing available slot.

cal_calendars_slots_controller_2024_09_04_update_reserved_slot

Update a reserved slot Parameters:
ParameterTypeRequiredDefaultDescription
uidstringYesuid
eventTypeIdnumberYesThe ID of the event type for which slot should be reserved.
reservationDurationnumberNoONLY for authenticated requests with api key, access token or OAuth credentials (ID + secret). For how many minutes the slot should be reserved - for this long time noone else can book this event type at start time. If not provided, defaults to 5 minutes.
slotDurationnumberNoBy default slot duration is equal to event type length, but if you want to reserve a slot for an event type that has a variable length you can specify it here as a number in minutes. If you don’t have this set explicitly that event type can have one of many lengths you can omit this.
slotStartstringYesISO 8601 datestring in UTC timezone representing available slot.