Cal

Learn how to use Cal with Composio

Overview

Enum

CAL

Description

Cal simplifies meeting coordination by providing shareable booking pages, calendar syncing, and availability management to streamline the scheduling process

Authentication Details

api_key
stringRequired
base_url
stringDefaults to https://api.cal.com/
client_id
stringRequired
client_secret
stringRequired
access_token
stringRequired
refresh_token
stringRequired

Actions

Adds a new member to a specified team within an organization by creating a team membership.

Action Parameters

accepted
boolean
disableImpersonation
boolean
orgId
integerRequired
role
stringDefaults to MEMBER
teamId
integerRequired
userId
integerRequired

Action Response

data
object
error
successful
boolean
Adds a new option to an organization's attribute, requiring a display `value` and a `slug` unique for that attribute.

Action Parameters

attributeId
stringRequired
orgId
integerRequired
slug
stringRequired
value
stringRequired

Action Response

data
object
error
successful
boolean
Cancels an existing and active cal.com booking using its unique identifier (uid).

Action Parameters

bookingUid
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves free/busy availability for a specified calendar to aid scheduling without revealing event details; requires an existing, accessible calendar, noting that data granularity can vary.

Action Parameters

calendar
stringRequired

Action Response

data
object
error
successful
boolean
Call this read-only action to verify the connection and synchronization status of a user's google calendar integration with cal.

Action Parameters

Action Response

data
object
error
successful
boolean
Checks an ics feed url (expected as a query parameter) to verify its validity, accessibility, and icalendar data integrity.

Action Parameters

Action Response

data
object
error
successful
boolean
Verifies if stripe is correctly connected to the cal scheduling system and functional for processing payments, reporting only on the integration's status.

Action Parameters

Action Response

data
object
error
successful
boolean
Retrieves the stripe integration status and related information for a team, primarily to verify account connection, subscription details, or payment setup; this is a read-only operation that does not modify stripe settings.

Action Parameters

teamId
stringRequired

Action Response

data
object
error
successful
boolean
Confirms an existing booking by `bookinguid` if the booking exists and is in a state allowing confirmation (e.g., not already cancelled or confirmed); this finalizes the booking, does not modify its details, and should typically be performed once.

Action Parameters

bookingUid
stringRequired

Action Response

data
object
error
successful
boolean
Initiates or checks the external connection status for a specified calendar, possibly returning a redirect url for user authorization to complete integration, without altering calendar data.

Action Parameters

calendar
stringRequired

Action Response

data
object
error
successful
boolean
Creates a new membership or updates an existing one for a user within an organization; the user specified by userid must already exist in the system.

Action Parameters

accepted
boolean
disableImpersonation
boolean
orgId
integerRequired
role
stringDefaults to MEMBER
userId
integerRequired

Action Response

data
object
error
successful
boolean
Creates a new managed user for an oauth client, setting profile and scheduling preferences; if `timezone` is not provided, a default schedule (mon-fri, 9am-5pm) is not created, requiring manual setup via `/schedules` endpoint before bookings are possible.

Action Parameters

avatarUrl
string
clientId
stringRequired
email
stringRequired
locale
string
name
stringRequired
timeFormat
integer
timeZone
string
weekStart
string

Action Response

data
object
error
successful
boolean
Creates a webhook for an existing oauth client to send real-time cal.com event notifications (e.g., `booking created`, `meeting ended`) to the `subscriberurl`, enabling integration with external systems or workflow automation.

Action Parameters

active
booleanRequired
clientId
stringRequired
payloadTemplate
string
secret
string
subscriberUrl
stringRequired
triggers
stringRequired

Action Response

data
object
error
successful
boolean
Creates a new custom attribute for an existing organization, used to enhance data collection for event bookings or user profiles.

Action Parameters

enabled
boolean
name
stringRequired
options
arrayRequired
orgId
integerRequired
slug
stringRequired
type
stringRequired

Action Response

data
object
error
successful
boolean
Creates a webhook for a specified, existing organization, sending notifications for selected trigger events to a designated, publicly accessible subscriber url that accepts post requests.

Action Parameters

active
booleanRequired
orgId
integerRequired
payloadTemplate
string
secret
string
subscriberUrl
stringRequired
triggers
stringRequired

Action Response

data
object
error
successful
boolean
Creates a new team profile, or updates one if a 'slug' matches, customizing branding, scheduling, privacy, and operational details.

Action Parameters

appIconLogo
string
appLogo
string
autoAcceptCreator
booleanDefaults to True
bannerUrl
string
bio
string
brandColor
string
calVideoLogo
string
darkBrandColor
string
hideBookATeamMember
boolean
hideBranding
boolean
isPrivate
boolean
logoUrl
string
metadata
string
name
stringRequired
slug
string
theme
string
timeFormat
integer
timeZone
stringDefaults to Europe/London
weekStart
stringDefaults to Sunday

Action Response

data
object
error
successful
boolean
Schedules a phone call event in cal.com using existing eventtype, organization, and team ids; this action only registers the event details and does not initiate the actual phone call.

Action Parameters

beginMessage
string
calApiKey
stringRequired
eventTypeId
integerRequired
generalPrompt
string
guestCompany
string
guestEmail
string
guestName
string
numberToCall
stringRequired
orgId
integerRequired
schedulerName
string
teamId
integerRequired
templateType
stringDefaults to CUSTOM_TEMPLATE
yourPhoneNumber
stringRequired

Action Response

data
object
error
successful
boolean
Creates a phone call template associated with an existing event type and team, for defining reusable call configurations like numbers and scripts; note this does not initiate an actual call.

Action Parameters

beginMessage
string
calApiKey
stringRequired
eventTypeId
integerRequired
generalPrompt
string
guestCompany
string
guestEmail
string
guestName
string
numberToCall
stringRequired
schedulerName
string
teamId
integerRequired
templateType
stringDefaults to CUSTOM_TEMPLATE
yourPhoneNumber
stringRequired

Action Response

data
object
error
successful
boolean
Creates a new event type for a specified team in cal.com; ensure `teamid`, any provided `scheduleid`, `hosts.userid`, and `destinationcalendar` details are valid and accessible.

Action Parameters

afterEventBuffer
integer
assignAllTeamMembers
boolean
beforeEventBuffer
integer
bookingFields
array
bookingLimitsCount
object
bookingLimitsDuration
object
bookingWindow
object
color__darkThemeHex
string
color__lightThemeHex
string
confirmationPolicy
object
customName
string
description
string
destinationCalendar__externalId
string
destinationCalendar__integration
string
disableGuests
boolean
hideCalendarEventDetails
boolean
hideCalendarNotes
boolean
hosts
arrayRequired
lengthInMinutes
integerRequired
lengthInMinutesOptions
arrayRequired
locations
array
lockTimeZoneToggleOnBookingPage
boolean
minimumBookingNotice
integer
offsetStart
integer
onlyShowFirstAvailableSlot
boolean
recurrence
object
requiresBookerEmailVerification
boolean
scheduleId
integer
seats
object
slotInterval
integer
slug
stringRequired
successRedirectUrl
string
teamId
integerRequired
title
stringRequired
useDestinationCalendarEmail
boolean

Action Response

data
object
error
successful
boolean
Creates a highly customizable cal.com team event type with extensive scheduling, booking, and host assignment options; `lengthinminutes` (as string) must be included in `lengthinminutesoptions`, destination calendar details (from `/api/v2/calendars`) must be valid, and host user ids must be valid team members.

Action Parameters

afterEventBuffer
integer
assignAllTeamMembers
boolean
beforeEventBuffer
integer
bookingFields
array
bookingLimitsCount
object
bookingLimitsDuration
object
bookingWindow
object
color__darkThemeHex
string
color__lightThemeHex
string
confirmationPolicy
object
customName
string
description
string
destinationCalendar__externalId
string
destinationCalendar__integration
string
disableGuests
boolean
hideCalendarEventDetails
boolean
hideCalendarNotes
boolean
hosts
arrayRequired
lengthInMinutes
integerRequired
lengthInMinutesOptions
arrayRequired
locations
array
lockTimeZoneToggleOnBookingPage
boolean
minimumBookingNotice
integer
offsetStart
integer
onlyShowFirstAvailableSlot
boolean
orgId
integerRequired
recurrence
object
requiresBookerEmailVerification
boolean
scheduleId
integer
seats
object
slotInterval
integer
slug
stringRequired
successRedirectUrl
string
teamId
integerRequired
title
stringRequired
useDestinationCalendarEmail
boolean

Action Response

data
object
error
successful
boolean
Creates a new team with customizable attributes within an existing and accessible cal.com organization specified by orgid.

Action Parameters

appIconLogo
string
appLogo
string
autoAcceptCreator
booleanDefaults to True
bannerUrl
string
bio
string
brandColor
string
calVideoLogo
string
darkBrandColor
string
hideBookATeamMember
boolean
hideBranding
boolean
isPrivate
boolean
logoUrl
string
metadata
string
name
stringRequired
orgId
integerRequired
slug
string
theme
string
timeFormat
integer
timeZone
stringDefaults to Europe/London
weekStart
stringDefaults to Sunday

Action Response

data
object
error
successful
boolean
Adds a user to a team with a specified role, acceptance status, and impersonation settings; ensure `teamid` and `userid` refer to existing, valid entities.

Action Parameters

accepted
boolean
disableImpersonation
boolean
role
stringDefaults to MEMBER
teamId
integerRequired
userId
integerRequired

Action Response

data
object
error
successful
boolean
Creates a cal.com user availability schedule, defining its name, timezone, weekly recurring availability, and specific date overrides; if `isdefault` is true, this schedule replaces any existing default and applies to event types not linked to a specific schedule.

Action Parameters

availability
array
isDefault
booleanRequired
name
stringRequired
overrides
array
timeZone
stringRequired

Action Response

data
object
error
successful
boolean
Creates a new schedule defining a user's availability with weekly slots and date-specific overrides in an organization; setting 'isdefault' to true may replace an existing default schedule for the user.

Action Parameters

availability
array
isDefault
booleanRequired
name
stringRequired
orgId
integerRequired
overrides
array
timeZone
stringRequired
userId
integerRequired

Action Response

data
object
error
successful
boolean
Creates a webhook for an existing `eventtypeid` in cal.com, sending notifications for specified `triggers` to a `subscriberurl` that handles post requests.

Action Parameters

active
booleanRequired
eventTypeId
integerRequired
payloadTemplate
string
secret
string
subscriberUrl
stringRequired
triggers
stringRequired

Action Response

data
object
error
successful
boolean
Declines a pending booking using its bookinguid, optionally with a reason; this action is irreversible and applies only to bookings awaiting confirmation.

Action Parameters

bookingUid
stringRequired
reason
string

Action Response

data
object
error
successful
boolean
Disconnects the specified conferencing application (e.g., 'zoom', 'google meet') for the cal.com account, immediately terminating any ongoing call or meeting; use with caution.

Action Parameters

app
stringRequired

Action Response

data
object
error
successful
boolean
Permanently deletes an existing event type by its id, which invalidates its scheduling links; the operation is irreversible, and while existing bookings are unaffected, no new bookings can be made for this event type.

Action Parameters

eventTypeId
integerRequired

Action Response

data
object
error
successful
boolean
Permanently removes an event type's configuration from a team's scheduling options (e.g., for cleanup); this action is irreversible and requires the event type to be associated with the team.

Action Parameters

eventTypeId
integerRequired
teamId
integerRequired

Action Response

data
object
error
successful
boolean
Use to permanently remove a user's membership from a specific team within an organization, which revokes their team-associated access but does not remove them from the organization.

Action Parameters

membershipId
integerRequired
orgId
integerRequired
teamId
integerRequired

Action Response

data
object
error
successful
boolean
Irreversibly revokes a specific user's association with a given oauth client, without deleting the user's cal account.

Action Parameters

clientId
stringRequired
userId
integerRequired

Action Response

data
object
error
successful
boolean
Permanently deletes a specific webhook subscription of an oauth client in the cal application, stopping its notifications.

Action Parameters

clientId
stringRequired
webhookId
stringRequired

Action Response

data
object
error
successful
boolean
Permanently deletes an existing attribute (specified by `attributeid`) from an existing organization (specified by `orgid`); this action is irreversible and may affect features dependent on the attribute.

Action Parameters

attributeId
stringRequired
orgId
integerRequired

Action Response

data
object
error
successful
boolean
Permanently deletes a specified option from an organization's attribute, typically to remove an unnecessary configuration choice.

Action Parameters

attributeId
stringRequired
optionId
stringRequired
orgId
integerRequired

Action Response

data
object
error
successful
boolean
Irreversibly deletes a user's membership from an organization, removing all associated access and permissions; the response confirms deletion without returning details of the deleted membership.

Action Parameters

membershipId
integerRequired
orgId
integerRequired

Action Response

data
object
error
successful
boolean
Permanently deletes an organization's webhook, which stops all its notifications; this action is irreversible and the webhook cannot be recovered.

Action Parameters

orgId
integerRequired
webhookId
stringRequired

Action Response

data
object
error
successful
boolean
Permanently deletes a specific schedule using its unique identifier, which must correspond to an existing schedule.

Action Parameters

scheduleId
integerRequired

Action Response

data
object
error
successful
boolean
Removes a specified, currently selected calendar from the user's active list within the application, without deleting it from the external provider.

Action Parameters

credentialId
stringRequired
externalId
stringRequired
integration
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a previously selected time slot from the cal schedule using its `uid`; the slot must exist and this action is irreversible.

Action Parameters

uid
stringRequired

Action Response

data
object
error
successful
boolean
Permanently and irreversibly deletes an existing team and all its associated data from the cal system, using the team's unique `teamid`.

Action Parameters

teamId
integerRequired

Action Response

data
object
error
successful
boolean
Permanently and irreversibly deletes a specific team (and all its associated data, members, and linked projects/events) from an organization, when the team is no longer needed or during organizational restructuring.

Action Parameters

orgId
integerRequired
teamId
integerRequired

Action Response

data
object
error
successful
boolean
Irreversibly removes a user's team membership in the cal application, revoking access to that specific team; the user's overall cal account remains active.

Action Parameters

membershipId
integerRequired
teamId
integerRequired

Action Response

data
object
error
successful
boolean
Removes a custom attribute option (e.g., skill, role) currently assigned to a user within an organization; this operation is irreversible.

Action Parameters

attributeOptionId
stringRequired
orgId
integerRequired
userId
integerRequired

Action Response

data
object
error
successful
boolean
Permanently removes a user from a specific organization (user's system-wide account is unaffected), revoking their access rights therein; this action is irreversible via api and expects the user to be a current member.

Action Parameters

orgId
integerRequired
userId
integerRequired

Action Response

data
object
error
successful
boolean
Permanently deletes a specific user's schedule, provided the organization, user, and schedule (identified by `orgid`, `userid`, and `scheduleid`) exist.

Action Parameters

orgId
integerRequired
scheduleId
integerRequired
userId
integerRequired

Action Response

data
object
error
successful
boolean
Call this to irreversibly delete all webhooks for a specific `eventtypeid` if the event type exists; details of deleted webhooks are not returned.

Action Parameters

eventTypeId
integerRequired

Action Response

data
object
error
successful
boolean
Permanently deletes an existing webhook by its `webhookid`, stopping future notifications; this action is irreversible.

Action Parameters

webhookId
stringRequired

Action Response

data
object
error
successful
boolean
Permanently deletes a specific webhook for an event type, halting its real-time notifications; this operation is irreversible and leaves the event type and other webhooks untouched.

Action Parameters

eventTypeId
integerRequired
webhookId
stringRequired

Action Response

data
object
error
successful
boolean
Disconnects a calendar integration by its provider name and credential id, irreversibly revoking cal's access; external calendar data remains unaffected.

Action Parameters

calendar
stringRequired
id
integerRequired

Action Response

data
object
error
successful
boolean
Fetches a list of bookings, optionally filtered by status, attendee, date range, or by event/team ids (which must belong to/include the authenticated user respectively), with support for pagination and sorting.

Action Parameters

afterStart
string
attendeeEmail
string
attendeeName
string
beforeEnd
string
eventTypeId
string
eventTypeIds
string
skip
integer
sortCreated
string
sortEnd
string
sortStart
string
status
array
take
integer
teamId
string
teamsIds
string

Action Response

data
object
error
successful
boolean
Fetches all configuration settings and characteristics for a single event type (identified by orgid, teamid, and eventtypeid), which must exist and be accessible; this read-only action cannot list, create, or modify event types.

Action Parameters

eventTypeId
integerRequired
orgId
integerRequired
teamId
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific attribute of an organization, useful for fetching a single data point instead of the entire organization record.

Action Parameters

attributeId
stringRequired
orgId
integerRequired

Action Response

data
object
error
successful
boolean
Fetches an oauth access token for the specified `clientid` to authenticate api calls; this action only retrieves the token, not managing scheduling or calendar events.

Action Parameters

clientId
stringRequired

Action Response

data
object
error
successful
boolean
Fetches comprehensive details for a specific, existing schedule using its `scheduleid`.

Action Parameters

scheduleId
integerRequired

Action Response

data
object
error
successful
boolean
Fetches a specific user's schedule, potentially including events and availability, using `orgid`, `userid`, and `scheduleid`.

Action Parameters

orgId
integerRequired
scheduleId
integerRequired
userId
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves details for a single, specific webhook using its `webhookid` and associated `eventtypeid`.

Action Parameters

eventTypeId
integerRequired
webhookId
stringRequired

Action Response

data
object
error
successful
boolean
Forces an immediate refresh of oauth tokens for a specified user and client, bypassing the normal expiration cycle, typically when existing tokens are suspected to be invalid or fresh credentials are required; ensure the user exists, the client is registered, and prior authorization is valid.

Action Parameters

clientId
stringRequired
userId
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves all supported time zone identifiers (e.g., 'america/new york', 'europe/london') and their associated metadata, excluding specific dst changes or precise utc offset details.

Action Parameters

Action Response

data
object
error
successful
boolean
Retrieves available time slots for scheduling by considering existing bookings and availability, based on criteria like a specified time range and event type.

Action Parameters

duration
integer
endTime
stringRequired
eventTypeId
integerRequired
eventTypeSlug
string
orgSlug
string
rescheduleUid
string
slotFormat
string
startTime
stringRequired
timeZone
string
usernameList
array

Action Response

data
object
error
successful
boolean
Generates an oauth 2.0 authorization url for a supported conferencing `app` to initiate or refresh its integration with cal.com.

Action Parameters

app
stringRequired
onErrorReturnTo
stringRequired
returnTo
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves the cal system's global default schedule configuration, not custom or user-specific ones.

Action Parameters

Action Response

data
object
error
successful
boolean
Retrieves a specific event type by its id, requiring that the event type is associated with the given team id.

Action Parameters

eventTypeId
integerRequired
teamId
integerRequired

Action Response

data
object
error
successful
boolean
Generates the initial google calendar oauth 2.0 authorization url for user redirection to begin the authentication and authorization process.

Action Parameters

Action Response

data
object
error
successful
boolean
Retrieves users associated with a specific oauth client (identified by a valid `clientid`) for auditing access or managing permissions.

Action Parameters

clientId
stringRequired
limit
integer

Action Response

data
object
error
successful
boolean
Retrieves all organization ids associated with the currently authenticated user.

Action Parameters

Action Response

data
array
error
successful
boolean
Retrieves a list of schedules (e.g., events, appointments) for an organization, providing basic schedule information, not detailed individual event data.

Action Parameters

orgId
integerRequired
skip
integer
take
integer

Action Response

data
object
error
successful
boolean
Retrieves event types, including names, durations, and custom settings for team scheduling, for all teams within an existing organization specified by `orgid`.

Action Parameters

orgId
integerRequired
skip
integer
take
integer

Action Response

data
object
error
successful
boolean
Fetches all schedule information for a specific user within an organization; handle potential pagination for extensive schedules.

Action Parameters

orgId
integerRequired
userId
integerRequired

Action Response

data
object
error
successful
boolean
Fetches all scheduled events or appointments for a specified user within their team and organization.

Action Parameters

orgId
integerRequired
teamId
integerRequired
userId
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves stripe connect account details (id, charges/payouts status, verification, settings) for the user's linked cal.com account; response may be empty or indicate no integration if no account is linked.

Action Parameters

Action Response

data
object
error
successful
boolean
Retrieves all teams the user belongs to, including their names and members.

Action Parameters

Action Response

data
object
error
successful
boolean
Retrieves comprehensive details (e.g., members, roles, metadata) for a specific team using its `teamid` within an organization specified by `orgid`.

Action Parameters

orgId
integerRequired
teamId
integerRequired

Action Response

data
object
error
successful
boolean
Fetches comprehensive details for an existing team using its unique id; returned fields may vary by team configuration and user permissions.

Action Parameters

teamId
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves details for an existing and accessible webhook by its id; this is a read-only operation.

Action Parameters

webhookId
stringRequired

Action Response

data
object
error
successful
boolean
Processes an oauth 2.0 callback for a conferencing `app`, exchanging the `code` and `state` for access credentials; ensure an oauth flow was previously initiated.

Action Parameters

app
stringRequired
code
stringRequired
state
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves cal event types, filterable by `username` (required if `eventslug` is provided), multiple `usernames`, or organization details (`orgslug` or `orgid`).

Action Parameters

eventSlug
string
orgId
integer
orgSlug
string
username
string
usernames
string

Action Response

data
object
error
successful
boolean
Retrieves all memberships for a given organization, including user details, roles, status, and membership dates.

Action Parameters

orgId
integerRequired
skip
integer
take
integer

Action Response

data
object
error
successful
boolean
Retrieves all event types for a specific team within an organization, optionally filtering by a specific event slug.

Action Parameters

eventSlug
string
orgId
integerRequired
teamId
integerRequired

Action Response

data
object
error
successful
boolean
Marks the host and/or specified attendees as absent for an existing booking, typically used after a scheduled event to record no-shows.

Action Parameters

attendees
array
bookingUid
stringRequired
host
boolean

Action Response

data
object
error
successful
boolean
Updates an organization membership's status (accepted), role, or impersonation settings, identified by `orgid` and `membershipid` in the path; requires at least one of these fields in the request to apply changes.

Action Parameters

accepted
boolean
disableImpersonation
boolean
membershipId
integerRequired
orgId
integerRequired
role
string

Action Response

data
object
error
successful
boolean
Partially updates an organization attribute using `orgid` and `attributeid`, allowing modification of its name, slug, type, or enabled status; changing the 'type' may affect existing data.

Action Parameters

attributeId
stringRequired
enabled
boolean
name
string
orgId
integerRequired
slug
string
type
string

Action Response

data
object
error
successful
boolean
Partially updates a specific option for an organization's attribute, modifying its 'value' and/or 'slug'; at least one of 'value' or 'slug' must be provided.

Action Parameters

attributeId
stringRequired
optionId
stringRequired
orgId
integerRequired
slug
string
value
string

Action Response

data
object
error
successful
boolean
Partially updates details for a user that exists within the specified organization.

Action Parameters

orgId
integerRequired
userId
integerRequired

Action Response

data
object
error
successful
boolean
Updates specified details for an existing team identified by `teamid`; unspecified fields remain unchanged.

Action Parameters

appIconLogo
string
appLogo
string
bannerUrl
string
bio
string
bookingLimits
string
brandColor
string
calVideoLogo
string
darkBrandColor
string
hideBookATeamMember
boolean
hideBranding
boolean
includeManagedEventsInLimits
boolean
isPrivate
boolean
logoUrl
string
metadata
string
name
string
slug
string
teamId
integerRequired
theme
string
timeFormat
integer
timeZone
string
weekStart
string

Action Response

data
object
error
successful
boolean
Updates configuration (e.g., payload template, active status, url, triggers, secret) for an existing webhook tied to a specific event type.

Action Parameters

active
boolean
eventTypeId
integerRequired
payloadTemplate
string
secret
string
subscriberUrl
string
triggers
string
webhookId
stringRequired

Action Response

data
object
error
successful
boolean
Use to submit/update authentication credentials (passed in the request body) for an existing calendar, enabling cal to connect with external calendar services for synchronization.

Action Parameters

calendar
stringRequired

Action Response

data
object
error
successful
boolean
Connects or reconnects cal.com with a specified conferencing application to enable future virtual meeting scheduling, but does not itself create or schedule meetings.

Action Parameters

app
stringRequired

Action Response

data
object
error
successful
boolean
Creates a new booking for an active event type, scheduling it for a specified start time (preferably in the future) with primary attendee details and optional customizations.

Action Parameters

attendee
objectRequired
bookingFieldsResponses
object
eventTypeId
integerRequired
guests
array
lengthInMinutes
integer
location
object
metadata
object
start
stringRequired

Action Response

data
object
error
successful
boolean
Assigns an existing attribute option (using `attributeoptionid`) or creates a new one (using `value`) for a user, linking it to a specified `attributeid` which must already exist within the organization.

Action Parameters

attributeId
stringRequired
attributeOptionId
string
orgId
integerRequired
userId
integerRequired
value
string

Action Response

data
object
error
successful
boolean
Links a new external calendar or updates an existing link to one, enabling synchronization with the cal application by specifying the `integration` provider, the calendar's `externalid`, and the `credentialid`.

Action Parameters

credentialId
integerRequired
externalId
stringRequired
integration
stringRequired

Action Response

data
object
error
successful
boolean
Adds a new user to an existing organization (identified by `orgid` in path), requiring user's `email` and allowing extensive optional profile customization.

Action Parameters

appTheme
string
autoAccept
booleanDefaults to True
avatarUrl
string
brandColor
string
darkBrandColor
string
defaultScheduleId
integer
email
stringRequired
hideBranding
boolean
locale
stringDefaults to en
orgId
integerRequired
organizationRole
stringDefaults to MEMBER
theme
string
timeFormat
integer
timeZone
string
username
string
weekday
string

Action Response

data
object
error
successful
boolean
Creates a new cal.com webhook subscription to send real-time notifications for specified calendar events to a publicly accessible subscriber url.

Action Parameters

active
booleanRequired
payloadTemplate
string
secret
string
subscriberUrl
stringRequired
triggers
stringRequired

Action Response

data
object
error
successful
boolean
Reassigns an existing, active booking to a specified, authorized user; does not notify participants of this change.

Action Parameters

bookingUid
stringRequired
reason
string
userId
integerRequired

Action Response

data
object
error
successful
boolean
Reassigns the specified booking to a new team member, who is determined by the system rather than being specified in the request.

Action Parameters

bookingUid
stringRequired

Action Response

data
object
error
successful
boolean
Refreshes an oauth access token for a specified `clientid` and managed user using their `refreshtoken`, enabling continued api access when the current token is near or past expiry.

Action Parameters

clientId
stringRequired
refreshToken
stringRequired

Action Response

data
object
error
successful
boolean
Reschedules an existing booking (identified by `bookinguid`) to a new time, provided the new slot's availability is confirmed beforehand; all other rescheduling parameters (e.g., new date, time) must be sent in the post request body, not via this action's direct parameters.

Action Parameters

bookingUid
stringRequired

Action Response

data
object
error
successful
boolean
Temporarily reserves an available time slot for an existing and bookable event type, useful for high-demand slots to prevent double-bookings while the user completes the booking.

Action Parameters

bookingUid
string
eventTypeId
integerRequired
slotUtcEndDate
stringRequired
slotUtcStartDate
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves all available options for a specific attribute within a designated organization, requiring valid and associated `orgid` and `attributeid`.

Action Parameters

attributeId
stringRequired
orgId
integerRequired

Action Response

data
object
error
successful
boolean
Fetches comprehensive details for an existing booking, identified by its `bookinguid`.

Action Parameters

bookingUid
stringRequired

Action Response

data
object
error
successful
boolean
To find busy calendar slots for scheduling/conflict detection, call this with a valid `credentialid`, an `externalid` accessible by it, and a recognized iana `loggedinuserstz`; returns only busy intervals, not event details or free slots.

Action Parameters

credentialId
integerRequired
dateFrom
string
dateTo
string
externalId
stringRequired
loggedInUsersTz
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a list of all calendar summaries (no event details) associated with the authenticated user's account.

Action Parameters

Action Response

data
object
error
successful
boolean
Retrieves details of the team(s) for the currently authenticated user within the specified organization `orgid`.

Action Parameters

orgId
integerRequired
skip
integer
take
integer

Action Response

data
object
error
successful
boolean
Retrieves an account's or organization's read-only default conferencing settings in cal.com (e.g., video platform, meeting duration) to inform event creation or ensure consistency.

Action Parameters

Action Response

data
object
error
successful
boolean
Retrieves comprehensive details for a specific, existing cal.com event type using its unique id; this is a read-only action and does not return associated events or bookings.

Action Parameters

eventTypeId
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information about a specific membership within a particular organization.

Action Parameters

membershipId
integerRequired
orgId
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves the authenticated user's core profile information (e.g., name, email, timezone); does not retrieve related data like calendar events or schedules.

Action Parameters

Action Response

data
object
error
successful
boolean
Retrieves detailed information for an existing user specifically associated with an existing oauth client.

Action Parameters

clientId
stringRequired
userId
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves a specific webhook using its `webhookid` and the `clientid` of its associated oauth client.

Action Parameters

clientId
stringRequired
webhookId
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed attributes (e.g., configurations, settings, metadata) for an organization, identified by its `orgid`, which must correspond to an existing organization.

Action Parameters

orgId
integerRequired
skip
integer
take
integer

Action Response

data
object
error
successful
boolean
Fetches all available attribute options for a specific user within a given organization, provided the organization and user exist and the user is part of the organization.

Action Parameters

orgId
integerRequired
userId
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves a list of webhooks for an organization specified by `orgid`, supporting pagination; this is a read-only operation.

Action Parameters

orgId
integerRequired
skip
integer
take
integer

Action Response

data
object
error
successful
boolean
Retrieves detailed information, including configuration and status, for a specific webhook by its id (`webhookid`) within a given organization (`orgid`).

Action Parameters

orgId
integerRequired
webhookId
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information for an existing provider in the cal scheduling system using their unique client id.

Action Parameters

clientId
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a comprehensive list of all schedules associated with the authenticated user's cal.com account or organization.

Action Parameters

Action Response

data
object
error
successful
boolean
Retrieves a paginated list of teams and their details for a specific organization id; individual team member details or schedules are not included.

Action Parameters

orgId
integerRequired
skip
integer
take
integer

Action Response

data
object
error
successful
boolean
Retrieves event types for a team within the cal scheduling system; this action does not provide details on scheduled instances or member availability.

Action Parameters

eventSlug
string
teamId
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves a list of memberships, detailing member roles and statuses, for an existing team specified by `teamid`, with support for pagination.

Action Parameters

skip
integer
take
integer
teamId
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves all user memberships, including their roles and states, for a specific team within an organization.

Action Parameters

orgId
integerRequired
skip
integer
take
integer
teamId
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information, including role and status, for a specific team membership using its id, for a given organization and team.

Action Parameters

membershipId
integerRequired
orgId
integerRequired
teamId
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed attributes for a specific team membership by its id and the team id, such as member information, role, and status; does not list all team members.

Action Parameters

membershipId
integerRequired
teamId
integerRequired

Action Response

data
object
error
successful
boolean
Retrieves users associated with a specific organization id, excluding individual scheduling or calendar data; the `orgid` must be a valid identifier for an existing organization.

Action Parameters

emails
array
orgId
integerRequired
skip
integer
take
integer

Action Response

data
object
error
successful
boolean
Retrieves an authenticated cal user's or organization's video conferencing configurations, capabilities, and installed apps, useful for understanding options before scheduling or verifying setups; provider availability may vary by subscription or settings.

Action Parameters

Action Response

data
object
error
successful
boolean
Retrieves a paginated list of webhooks (including urls, subscribed events, and status) for a specified, existing event type id, useful for auditing configurations or troubleshooting.

Action Parameters

eventTypeId
integerRequired
skip
integer
take
integer

Action Response

data
object
error
successful
boolean
Retrieves a paginated list of webhooks from the user's cal scheduling system account, which are used for real-time notifications on events like new bookings, cancellations, or updates.

Action Parameters

skip
integer
take
integer

Action Response

data
object
error
successful
boolean
Retrieves a list of webhooks for a specific oauth client, supporting pagination.

Action Parameters

clientId
stringRequired
skip
integer
take
integer

Action Response

data
object
error
successful
boolean
Saves or updates a calendar's settings using a get request, typically for data already on the server or simple updates via query parameters.

Action Parameters

calendar
stringRequired
code
stringRequired
state
stringRequired

Action Response

data
object
error
successful
boolean
Imports and saves one or more publicly accessible external icalendar (ics) feed urls into the cal.com calendar system.

Action Parameters

readOnly
booleanDefaults to True
urls
arrayRequired

Action Response

data
object
error
successful
boolean
Completes the google calendar oauth 2.0 flow by exchanging the `code` and `state` (received from google's redirect after user consent) for access and refresh tokens.

Action Parameters

code
stringRequired
state
stringRequired

Action Response

data
object
error
successful
boolean
Completes the stripe oauth flow by saving stripe details; call this when a user is redirected back from stripe with an authorization `code` and `state`.

Action Parameters

code
stringRequired
state
stringRequired

Action Response

data
object
error
successful
boolean
Sets the specified, valid, and configured conferencing application as the default for new meetings for the authenticated user.

Action Parameters

app
stringRequired

Action Response

data
object
error
successful
boolean
Updates the destination calendar for syncing events, using `integration` and `externalid` (typically from `/calendars` endpoint).

Action Parameters

externalId
stringRequired
integration
stringRequired

Action Response

data
object
error
successful
boolean
Updates specified profile and scheduling preference fields for a user associated with an oauth client; `defaultscheduleid`, if provided, must be an existing, valid schedule for the user.

Action Parameters

avatarUrl
string
clientId
stringRequired
defaultScheduleId
integer
email
string
locale
string
name
string
timeFormat
integer
timeZone
string
userId
integerRequired
weekStart
string

Action Response

data
object
error
successful
boolean
Updates specified properties of an existing webhook for an oauth client; omitted fields remain unchanged.

Action Parameters

active
boolean
clientId
stringRequired
payloadTemplate
string
secret
string
subscriberUrl
string
triggers
string
webhookId
stringRequired

Action Response

data
object
error
successful
boolean
Updates an existing schedule by its id, allowing partial modification of properties; providing `availability` or `overrides` replaces them entirely.

Action Parameters

availability
array
isDefault
boolean
name
string
overrides
array
scheduleId
stringRequired
timeZone
string

Action Response

data
object
error
successful
boolean
Updates an existing team's information by its id within a specified organization; the `slug`, if provided, must be unique within the organization.

Action Parameters

appIconLogo
string
appLogo
string
bannerUrl
string
bio
string
bookingLimits
string
brandColor
string
calVideoLogo
string
darkBrandColor
string
hideBookATeamMember
boolean
hideBranding
boolean
includeManagedEventsInLimits
boolean
isPrivate
boolean
logoUrl
string
metadata
string
name
string
orgId
integerRequired
slug
string
teamId
integerRequired
theme
string
timeFormat
integer
timeZone
string
weekStart
string

Action Response

data
object
error
successful
boolean
Updates specified properties (e.g., acceptance status, role, impersonation settings) of an existing team membership, identified by `teamid` and `membershipid`, supporting partial updates where only provided fields are modified.

Action Parameters

accepted
boolean
disableImpersonation
boolean
membershipId
integerRequired
role
string
teamId
integerRequired

Action Response

data
object
error
successful
boolean
Updates attributes like acceptance status, role, or impersonation settings for an existing team membership; only provided fields are changed, and this action cannot create or delete memberships.

Action Parameters

accepted
boolean
disableImpersonation
boolean
membershipId
integerRequired
orgId
integerRequired
role
string
teamId
integerRequired

Action Response

data
object
error
successful
boolean
Updates the profile information and preferences for the authenticated user, affecting only the fields provided in the request.

Action Parameters

avatarUrl
string
defaultScheduleId
integer
email
string
locale
string
name
string
timeFormat
integer
timeZone
string
weekStart
string

Action Response

data
object
error
successful
boolean
Modifies an existing schedule for a specified user within an organization by updating only the provided fields; the organization, user, and schedule must already exist.

Action Parameters

availability
array
isDefault
boolean
name
string
orgId
integerRequired
overrides
array
scheduleId
integerRequired
timeZone
string
userId
integerRequired

Action Response

data
object
error
successful
boolean
Updates an existing cal.com webhook by its `webhookid`, allowing partial modification of its attributes; only explicitly provided fields will be changed.

Action Parameters

active
boolean
payloadTemplate
string
secret
string
subscriberUrl
string
triggers
string
webhookId
stringRequired

Action Response

data
object
error
successful
boolean
Use this action to modify settings of an already created webhook for an organization, such as its target url, active status, or the events that trigger it.

Action Parameters

active
boolean
orgId
integerRequired
payloadTemplate
string
secret
string
subscriberUrl
string
triggers
string
webhookId
stringRequired

Action Response

data
object
error
successful
boolean