141 things your agent can do in 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.

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.

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…

Fetch all bookings

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 a…

Fetch organization attribute by id

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

Fetch provider access token

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.

Get all timezones

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.

Get available slots info

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

Get conference OAuth authorization url

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

Get oauth clients user

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

Get organization ID

Retrieves all organization ids associated with the currently authenticated user.

Get organization schedules

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

Get organization user schedules

Fetches all schedule information for a specific user within an organization; handle potential pagination for extensive schedules.

Get stripe connect info

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…

Get teams list

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

Get team details by organization ID and team ID

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

Get team information by team ID

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

Get webhook by id

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

List organization memberships

Retrieves all memberships for a given organization, including user details, roles, status, and membership dates.

Retrieve attribute options for org

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

Retrieve booking details by uid

Fetches comprehensive details for an existing booking, identified by its `bookinguid`.

Retrieve current team for organization

Retrieves details of the team(s) for the currently authenticated user within the specified organization `orgid`.

Retrieve default conferencing settings

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.

Retrieve membership from organization

Retrieves detailed information about a specific membership within a particular organization.

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.

Retrieve OAuth client user by ID

Retrieves detailed information for an existing user specifically associated with an existing oauth client.

Retrieve oauth client webhook by id

Retrieves a specific webhook using its `webhookid` and the `clientid` of its associated oauth client.

Retrieve organization attributes

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

Retrieve organization attributes options

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.

Retrieve organization webhooks by org ID

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

Retrieve organization webhook by id

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

Retrieve provider details

Retrieves detailed information for an existing provider in the cal scheduling system using their unique client id.

Retrieve schedules list

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

Retrieve team details in organization

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

Retrieve team memberships

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

Retrieve team memberships for organization

Retrieves all user memberships, including their roles and states, for a specific team within an organization.

Retrieve team membership by id

Retrieves detailed information, including role and status, for a specific team membership using its id, for a given organization and team.

Retrieve team membership details

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.

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.

Retrieve v2 conferencing info

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; pr…

Retrieve webhooks list

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.

Retrieve webhook details for oauth client

Retrieves a list of webhooks for a specific oauth client, supporting pagination.

Add member to team

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

Add organization attribute option

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

Delete oauth client webhook

Permanently deletes a specific webhook subscription of an oauth client in the cal application, stopping its notifications.

Create membership for organization

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.

Create oauth client user

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…

Create OAuth client webhook configuration

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 syst…

Create organization attributes

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

Create organization webhook by org ID

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.

Create or update team profile

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

Create team in organization

Creates a new team with customizable attributes within an existing and accessible cal.com organization specified by orgid.

Create team membership with role

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

Delete conference app connection

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.

Delete membership in team

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.

Delete oauth client user

Irreversibly revokes a specific user's association with a given oauth client, without deleting the user's cal account.

Delete organization attribute

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 attri…

Delete organization attribute option

Permanently deletes a specified option from an organization's attribute, typically to remove an unnecessary configuration choice.

Delete organization membership

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.

Delete org webhook

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

Delete selected calendars

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

Delete team by id

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

Delete team from organization

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 organizationa…

Delete team memberships by id

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.

Delete user attribute option

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

Delete user from organization

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 b…

Delete webhook by id

Permanently deletes an existing webhook by its `webhookid`, stopping future notifications; this action is irreversible.

Patch organization attribute option

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.

Patch organization user details

Partially updates details for a user that exists within the specified organization.

Patch team details by ID

Updates specified details for an existing team identified by `teamid`; unspecified fields remain unchanged.

Set default conferencing app

Sets the specified, valid, and configured conferencing application as the default for new meetings for the authenticated user.

Update OAuth client user settings

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.

Update oauth client webhook

Updates specified properties of an existing webhook for an oauth client; omitted fields remain unchanged.

Update team information by id

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

Update team membership by id

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 p…

Update team membership properties

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.

Update user profile details

Updates the profile information and preferences for the authenticated user, affecting only the fields provided in the request.

Update webhook by id

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

Update webhook for organization

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.

Post calendar credentials

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.

Connect conferencing app

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

Post a new booking request

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.

Assign or create attribute option for user

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 organizat…

Add selected calendar

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 `cre…

Post user to organization

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

Post webhook event

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

Check calendar availability

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.

Check ics feed calendar endpoint

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

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.

Create phone call event

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.

Create phone call for event type

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.

Create team event type

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.

Create team event types with custom options

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`, dest…

Create user availability schedule

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 defa…

Create user schedule in organization

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 us…

Create webhook for event type

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

Delete event type by id

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 fo…

Delete event type in team

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.

Delete schedule by id

Permanently deletes a specific schedule using its unique identifier, which must correspond to an existing schedule.

Delete selected slot

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

Delete user schedule

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

Delete webhooks for event type

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

Delete webhook for event type

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.

Disconnect calendar using credential id

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

Fetch event type details

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, c…

Fetch schedule by id

Fetches comprehensive details for a specific, existing schedule using its `scheduleid`.

Fetch user schedule by org id

Fetches a specific user's schedule, potentially including events and availability, using `orgid`, `userid`, and `scheduleid`.

Fetch webhook by event type id

Retrieves details for a single, specific webhook using its `webhookid` and associated `eventtypeid`.

Get default schedule details

Retrieves the cal system's global default schedule configuration, not custom or user-specific ones.

Get event type by team id

Retrieves a specific event type by its id, requiring that the event type is associated with the given team id.

Get google calendar oauth authentication url

Generates the initial google calendar oauth 2.0 authorization url for user redirection to begin the authentication and authorization process.

Get organization teams event types

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

Get schedule for user in team

Fetches all scheduled events or appointments for a specified user within their team and organization.

List event types

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

List team event types by org and team id

Retrieves all event types for a specific team within an organization, optionally filtering by a specific event slug.

Patch webhook event type

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

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.

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 inte…

Retrieve calendar list

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

Retrieve event type by id

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.

Retrieve team event types

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

Retrieve webhooks for event type

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.

Save calendar entry

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

Save calendar ics feeds

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

Update destination calendar integration

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

Update schedule by ID

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

Update user schedule in organization

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.

Cancel booking via uid

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

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…

Decline booking with reason

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

Force refresh user oauth client

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…

Handle conferencing oauth callback for app

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.

Mark booking absent for UID

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

Modify organization membership by id

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…

Modify org attribute by id

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.

Reassign booking to another user

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

Reassign booking with uid

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

Refresh oauth token for client id

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.

Reschedule booking by uid

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…

Save OAuth credentials via GCal API

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.

Save stripe details

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`.