Cal

Learn how to use Cal with Composio

Overview

SLUG

CAL

Description

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

Authentication Details

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

Tools

SLUG: CAL_CONNECT_TO_CALENDAR

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
objectRequired
error
string
successful
booleanRequired

SLUG: CAL_CREATE_OR_UPDATE_TEAM_PROFILE

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
objectRequired
error
string
successful
booleanRequired

SLUG: CAL_GET_ORGANIZATION_ID

Retrieves all organization ids associated with the currently authenticated user.

Action Parameters

Action Response

data
array
error
string
successful
booleanRequired

SLUG: CAL_GET_TEAMS_LIST

Retrieves all teams the user belongs to, including their names and members.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CAL_LIST_EVENT_TYPES

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
objectRequired
error
string
successful
booleanRequired

SLUG: CAL_RESERVE_SLOT_FOR_EVENT

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
objectRequired
error
string
successful
booleanRequired

SLUG: CAL_RETRIEVE_CALENDAR_BUSY_TIMES

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
objectRequired
error
string
successful
booleanRequired

SLUG: CAL_RETRIEVE_CALENDAR_LIST

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

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CAL_RETRIEVE_MY_INFORMATION

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
objectRequired
error
string
successful
booleanRequired

SLUG: CAL_RETRIEVE_TEAM_MEMBERSHIPS

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
objectRequired
error
string
successful
booleanRequired

SLUG: CAL_RETRIEVE_USERS_IN_ORGANIZATION

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
objectRequired
error
string
successful
booleanRequired

SLUG: CAL_ADD_MEMBER_TO_TEAM_USING_ORG_AND_TEAM_ID

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
objectRequired
error
string
successful
booleanRequired

SLUG: CAL_ADD_ORGANIZATION_ATTRIBUTE_OPTION

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
objectRequired
error
string
successful
booleanRequired

SLUG: CAL_CANCEL_BOOKING_VIA_UID

Cancels an existing and active cal.com booking using its unique identifier (uid).

Action Parameters

bookingUid
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CAL_CHECK_CALENDAR_VERSION_2

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
objectRequired
error
string
successful
booleanRequired

SLUG: CAL_CHECK_GCAL_SYNCHRONIZATION_STATUS

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
objectRequired
error
string
successful
booleanRequired

SLUG: CAL_CHECK_ICS_FEED_CALENDAR_ENDPOINT

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

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: CAL_CHECK_STRIPE_STATUS

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
objectRequired
error
string
successful
booleanRequired

SLUG: CAL_CHECK_TEAM_STRIPE_INTEGRATION_STATUS

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
objectRequired
error
string
successful
booleanRequired

SLUG: CAL_CONFIRM_BOOKING_BY_UID

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
objectRequired
error
string
successful
booleanRequired