/cal-calendars | Type: Application | PCID required: Yes
Tools
cal_calendars_conferencing_controller_connect
Connect your conferencing application Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app | string | Yes | — | Conferencing application type |
cal_calendars_conferencing_controller_default
Set your default conferencing application Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app | string | Yes | — | Conferencing application type |
cal_calendars_conferencing_controller_disconnect
Disconnect your conferencing application Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app | string | Yes | — | Conferencing application type |
cal_calendars_conferencing_controller_get_default
Get your default conferencing applicationcal_calendars_conferencing_controller_list_installed_conferencing_apps
List your conferencing applicationscal_calendars_conferencing_controller_redirect
Get OAuth conferencing app auth URL Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app | string | Yes | — | Conferencing application type |
returnTo | string | Yes | — | Return To |
onErrorReturnTo | string | Yes | — | On Error Return To |
cal_calendars_conferencing_controller_save
Conferencing app OAuth callback Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
state | string | Yes | — | The state value |
app | string | Yes | — | Conferencing application type |
code | string | Yes | — | The code value |
cal_calendars_controller_check
Check a calendar connection Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
calendar | string | Yes | — | The calendar value |
cal_calendars_controller_check_ics_feed
Check an ICS feedcal_calendars_controller_create_ics_feed
Save an ICS feed Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
readOnly | boolean | No | — | Whether to allowing writing to the calendar or not |
urls | string[] | Yes | — | An array of ICS URLs |
cal_calendars_controller_delete_calendar_credentials
Disconnect a calendar Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
calendar | string | Yes | — | The calendar value |
id | integer | Yes | — | Credential ID of the calendar to delete, as returned by the /calendars endpoint |
cal_calendars_controller_get_busy_times
Get busy times Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
loggedInUsersTz | string | No | — | Deprecated: Use timeZone instead. The timezone of the user represented as a string |
timeZone | string | No | — | The timezone for the busy times query represented as a string |
dateFrom | string | No | — | The starting date for the busy times query |
dateTo | string | No | — | The ending date for the busy times query |
credentialId | number | Yes | — | Credential Id |
externalId | string | Yes | — | External Id |
cal_calendars_controller_get_calendars
Get all calendarscal_calendars_controller_redirect
Get OAuth connect URL Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
calendar | string | Yes | — | The calendar value |
isDryRun | boolean | Yes | — | Is Dry Run |
redir | string | No | — | Redirect URL after successful calendar authorization. |
cal_calendars_controller_save
Save Google or Outlook calendar credentials Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
state | string | Yes | — | The state value |
code | string | Yes | — | The code value |
calendar | string | Yes | — | The calendar value |
cal_calendars_controller_sync_credentials
Save Apple calendar credentials Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
calendar | string | Yes | — | The calendar value |
password | string | Yes | — | The password value |
username | string | Yes | — | The username value |
cal_calendars_destination_calendars_controller_update_destination_calendars
Update destination calendars Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
delegationCredentialId | string | No | — | Delegation Credential Id |
externalId | string | Yes | — | Unique identifier used to represent the specific calendar, as returned by the /calendars endpoint |
integration | string | Yes | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cal-api-version | string | Yes | — | Must be set to 2024-06-11. If not set to this value, the endpoint will default to an older version. |
availability | object[] | No | — | Each 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. |
isDefault | boolean | Yes | — | Each 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. |
name | string | Yes | — | The name value |
overrides | object[] | No | — | Need to change availability for a specific date? Add an override. |
timeZone | string | Yes | — | Timezone 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cal-api-version | string | Yes | — | Must be set to 2024-06-11. If not set to this value, the endpoint will default to an older version. |
scheduleId | number | Yes | — | Schedule Id |
cal_calendars_schedules_controller_2024_06_11_get_default_schedule
Get default schedule Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cal-api-version | string | Yes | — | Must be set to 2024-06-11. If not set to this value, the endpoint will default to an older version. |
cal_calendars_schedules_controller_2024_06_11_get_schedule
Get a schedule Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cal-api-version | string | Yes | — | Must be set to 2024-06-11. If not set to this value, the endpoint will default to an older version. |
scheduleId | number | Yes | — | Schedule Id |
cal_calendars_schedules_controller_2024_06_11_get_schedules
Get all schedules Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cal-api-version | string | Yes | — | Must be set to 2024-06-11. If not set to this value, the endpoint will default to an older version. |
cal_calendars_schedules_controller_2024_06_11_update_schedule
Update a schedule Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cal-api-version | string | Yes | — | Must be set to 2024-06-11. If not set to this value, the endpoint will default to an older version. |
scheduleId | number | Yes | — | Schedule Id |
availability | object[] | No | — | The availability value |
isDefault | boolean | No | — | Is Default |
name | string | No | — | The name value |
overrides | object[] | No | — | The overrides value |
timeZone | string | No | — | Timezone identifier |
cal_calendars_selected_calendars_controller_add_selected_calendar
Add a selected calendar Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
credentialId | number | Yes | — | Credential Id |
delegationCredentialId | string | No | — | Delegation Credential Id |
externalId | string | Yes | — | External Id |
integration | string | Yes | — | The integration value |
cal_calendars_selected_calendars_controller_delete_selected_calendar
Delete a selected calendar Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
integration | string | Yes | — | The integration value |
externalId | string | Yes | — | External Id |
credentialId | number | Yes | — | Credential Id |
delegationCredentialId | string | No | — | Delegation Credential Id |
cal_calendars_slots_controller_2024_09_04_delete_reserved_slot
Delete a reserved slot Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cal-api-version | string | Yes | — | Must be set to 2024-09-04. If not set to this value, the endpoint will default to an older version. |
uid | string | Yes | — | The uid value |
cal_calendars_slots_controller_2024_09_04_get_available_slots
Get available time slots for an event type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cal-api-version | string | Yes | — | Must be set to 2024-09-04. If not set to this value, the endpoint will default to an older version. |
bookingUidToReschedule | string | No | — | The unique identifier of the booking being rescheduled. When provided will ensure that the original booking time appears within the returned available slots when rescheduling. |
start | string | Yes | — | Time 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. |
end | string | Yes | — | Time 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. |
organizationSlug | string | No | — | The slug of the organization to which user with username belongs or team with teamSlug belongs. |
teamSlug | string | No | — | The slug of the team who owns event type with eventTypeSlug - used when slots are checked for team event type. |
username | string | No | — | The username of the user who owns event type with eventTypeSlug - used when slots are checked for individual user event type. |
eventTypeSlug | string | No | — | The 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. |
eventTypeId | number | No | — | The ID of the event type for which available slots should be checked. |
usernames | string | No | — | The 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. |
format | string | No | — | Format 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. |
duration | number | No | — | If 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. |
timeZone | string | No | — | Time 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cal-api-version | string | Yes | — | Must be set to 2024-09-04. If not set to this value, the endpoint will default to an older version. |
uid | string | Yes | — | The uid value |
cal_calendars_slots_controller_2024_09_04_reserve_slot
Reserve a slot Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cal-api-version | string | Yes | — | Must be set to 2024-09-04. If not set to this value, the endpoint will default to an older version. |
eventTypeId | number | Yes | — | The ID of the event type for which slot should be reserved. |
reservationDuration | number | No | — | ONLY 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. |
slotDuration | number | No | — | By 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. |
slotStart | string | Yes | — | ISO 8601 datestring in UTC timezone representing available slot. |
cal_calendars_slots_controller_2024_09_04_update_reserved_slot
Update a reserved slot Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cal-api-version | string | Yes | — | Must be set to 2024-09-04. If not set to this value, the endpoint will default to an older version. |
uid | string | Yes | — | The uid value |
eventTypeId | number | Yes | — | The ID of the event type for which slot should be reserved. |
reservationDuration | number | No | — | ONLY 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. |
slotDuration | number | No | — | By 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. |
slotStart | string | Yes | — | ISO 8601 datestring in UTC timezone representing available slot. |

