Cal
Tools
Name & Description | Type |
---|---|
CAL_CONNECT_TO_CALENDARInitiates 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 |
CAL_CREATE_OR_UPDATE_TEAM_PROFILECreates a new team profile, or updates one if a 'slug' matches, customizing branding, scheduling, privacy, and operational details. | action |
CAL_GET_ORGANIZATION_IDRetrieves all organization ids associated with the currently authenticated user. | action |
CAL_GET_TEAMS_LISTRetrieves all teams the user belongs to, including their names and members. | action |
CAL_LIST_EVENT_TYPESRetrieves Cal event types, filterable by `username` (required if `eventslug` is provided), multiple `usernames`, or organization details (`orgslug` or `orgid`). | action |
CAL_RESERVE_SLOT_FOR_EVENTTemporarily 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 |
CAL_RETRIEVE_CALENDAR_BUSY_TIMESTo 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 |
CAL_RETRIEVE_CALENDAR_LISTRetrieves a list of all Calendar summaries (no event details) associated with the authenticated user's account. | action |
CAL_RETRIEVE_MY_INFORMATIONRetrieves the authenticated user's core profile information (e. | action |
CAL_RETRIEVE_TEAM_MEMBERSHIPSRetrieves a list of memberships, detailing member roles and statuses, for an existing team specified by `teamid`, with support for pagination. | action |
CAL_RETRIEVE_USERS_IN_ORGANIZATIONRetrieves 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 |
CAL_ADD_MEMBER_TO_TEAM_USING_ORG_AND_TEAM_IDAdds a new member to a specified team within an organization by creating a team membership. | action |
CAL_ADD_ORGANIZATION_ATTRIBUTE_OPTIONAdds a new option to an organization's attribute, requiring a display `value` and a `slug` unique for that attribute. | action |
CAL_CANCEL_BOOKING_VIA_UIDCancels an existing and active Cal. | action |
CAL_CHECK_CALENDAR_VERSION_2Retrieves 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 |
CAL_CHECK_GCAL_SYNCHRONIZATION_STATUSCall this read-only action to verify the connection and synchronization status of a user's google Calendar integration with Cal. | action |
CAL_CHECK_ICS_FEED_CALENDAR_ENDPOINTChecks an ics feed url (expected as a query parameter) to verify its validity, accessibility, and iCalendar data integrity. | action |
CAL_CHECK_STRIPE_STATUSVerifies if stripe is correctly connected to the Cal scheduling system and functional for processing payments, reporting only on the integration's status. | action |
CAL_CHECK_TEAM_STRIPE_INTEGRATION_STATUSRetrieves 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 |
CAL_CONFIRM_BOOKING_BY_UIDConfirms an existing booking by `bookinguid` if the booking exists and is in a state allowing confirmation (e. | action |
CAL_CREATE_MEMBERSHIP_FOR_ORGANIZATIONCreates 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 |
CAL_CREATE_OAUTH_CLIENT_USERCreates 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 |
CAL_CREATE_OAUTH_CLIENT_WEBHOOK_CONFIGURATIONCreates a webhook for an existing oauth client to send real-time Cal. | action |
CAL_CREATE_ORGANIZATION_ATTRIBUTESCreates a new custom attribute for an existing organization, used to enhance data collection for event bookings or user profiles. | action |
CAL_CREATE_ORGANIZATION_WEBHOOK_BY_ORG_IDCreates 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 |
CAL_CREATE_PHONE_CALL_EVENTSchedules a phone Call event in Cal. | action |
CAL_CREATE_PHONE_CALL_FOR_EVENT_TYPECreates 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 |
CAL_CREATE_TEAM_EVENT_TYPECreates a new event type for a specified team in Cal. | action |
CAL_CREATE_TEAM_EVENT_TYPES_WITH_CUSTOM_OPTIONSCreates a highly customizable Cal. | action |
CAL_CREATE_TEAM_IN_ORGANIZATIONCreates a new team with customizable attributes within an existing and accessible Cal. | action |
CAL_CREATE_TEAM_MEMBERSHIP_WITH_ROLEAdds a user to a team with a specified role, acceptance status, and impersonation settings; ensure `teamid` and `userid` refer to existing, valid entities. | action |
CAL_CREATE_USER_AVAILABILITY_SCHEDULECreates a Cal. | action |
CAL_CREATE_USER_SCHEDULE_IN_ORGANIZATIONCreates 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 |
CAL_CREATE_WEBHOOK_FOR_EVENT_TYPECreates a webhook for an existing `eventtypeid` in Cal. | action |
CAL_DECLINE_BOOKING_WITH_REASONDeclines a pending booking using its bookinguid, optionally with a reason; this action is irreversible and applies only to bookings awaiting confirmation. | action |
CAL_DELETE_CONFERENCE_APP_CONNECTIONDisconnects the specified conferencing application (e. | action |
CAL_DELETE_EVENT_TYPE_BY_IDPermanently 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 |
CAL_DELETE_EVENT_TYPE_IN_TEAMPermanently removes an event type's configuration from a team's scheduling options (e. | action |
CAL_DELETE_MEMBERSHIP_IN_TEAMUse 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 |
CAL_DELETE_OAUTH_CLIENT_USERIrreversibly revokes a specific user's association with a given oauth client, without deleting the user's Cal account. | action |
CAL_DELETE_OAUTH_CLIENT_WEBHOOKPermanently deletes a specific webhook subscription of an oauth client in the Cal application, stopping its notifications. | action |
CAL_DELETE_ORGANIZATION_ATTRIBUTEPermanently 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 |
CAL_DELETE_ORGANIZATION_ATTRIBUTE_OPTIONPermanently deletes a specified option from an organization's attribute, typiCally to remove an unnecessary configuration choice. | action |
CAL_DELETE_ORGANIZATION_MEMBERSHIPIrreversibly 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 |
CAL_DELETE_ORG_WEBHOOKPermanently deletes an organization's webhook, which stops all its notifications; this action is irreversible and the webhook cannot be recovered. | action |
CAL_DELETE_SCHEDULE_BY_IDPermanently deletes a specific schedule using its unique identifier, which must correspond to an existing schedule. | action |
CAL_DELETE_SELECTED_CALENDARSRemoves a specified, currently selected Calendar from the user's active list within the application, without deleting it from the external provider. | action |
CAL_DELETE_SELECTED_SLOTDeletes a previously selected time slot from the Cal schedule using its `uid`; the slot must exist and this action is irreversible. | action |
CAL_DELETE_TEAM_BY_IDPermanently and irreversibly deletes an existing team and all its associated data from the Cal system, using the team's unique `teamid`. | action |
CAL_DELETE_TEAM_FROM_ORGANIZATIONPermanently 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 |
CAL_DELETE_TEAM_MEMBERSHIPS_BY_IDIrreversibly 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 |
CAL_DELETE_USER_ATTRIBUTE_OPTIONRemoves a custom attribute option (e. | action |
CAL_DELETE_USER_FROM_ORGANIZATIONPermanently 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 |
CAL_DELETE_USER_SCHEDULEPermanently deletes a specific user's schedule, provided the organization, user, and schedule (identified by `orgid`, `userid`, and `scheduleid`) exist. | action |
CAL_DELETE_WEBHOOKS_FOR_EVENT_TYPECall this to irreversibly delete all webhooks for a specific `eventtypeid` if the event type exists; details of deleted webhooks are not returned. | action |
CAL_DELETE_WEBHOOK_BY_IDPermanently deletes an existing webhook by its `webhookid`, stopping future notifications; this action is irreversible. | action |
CAL_DELETE_WEBHOOK_FOR_EVENT_TYPEPermanently 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 |
CAL_DISCONNECT_CALENDAR_USING_CREDENTIAL_IDDisconnects a Calendar integration by its provider name and credential id, irreversibly revoking Cal's access; external Calendar data remains unaffected. | action |
CAL_FETCH_ALL_BOOKINGSFetches 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 |
CAL_FETCH_EVENT_TYPE_DETAILSFetches 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 |
CAL_FETCH_ORGANIZATION_ATTRIBUTE_BY_IDRetrieves a specific attribute of an organization, useful for fetching a single data point instead of the entire organization record. | action |
CAL_FETCH_PROVIDER_ACCESS_TOKENFetches 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 |
CAL_FETCH_SCHEDULE_BY_IDFetches comprehensive details for a specific, existing schedule using its `scheduleid`. | action |
CAL_FETCH_USER_SCHEDULE_BY_ORG_IDFetches a specific user's schedule, potentially including events and availability, using `orgid`, `userid`, and `scheduleid`. | action |
CAL_FETCH_WEBHOOK_BY_EVENT_TYPE_IDRetrieves details for a single, specific webhook using its `webhookid` and associated `eventtypeid`. | action |
CAL_FORCE_REFRESH_USER_OAUTH_CLIENTForces 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 |
CAL_GET_ALL_TIMEZONESRetrieves all supported time zone identifiers (e. | action |
CAL_GET_AVAILABLE_SLOTS_INFORetrieves available time slots for scheduling by considering existing bookings and availability, based on criteria like a specified time range and event type. | action |
CAL_GET_CONFERENCE_OAUTH_AUTHORIZATION_URLGenerates an oauth 2. | action |
CAL_GET_DEFAULT_SCHEDULE_DETAILSRetrieves the Cal system's global default schedule configuration, not custom or user-specific ones. | action |
CAL_GET_EVENT_TYPE_BY_TEAM_IDRetrieves a specific event type by its id, requiring that the event type is associated with the given team id. | action |
CAL_GET_GOOGLE_CALENDAR_OAUTH_AUTHENTICATION_URLGenerates the initial google Calendar oauth 2. | action |
CAL_GET_OAUTH_CLIENTS_USERRetrieves users associated with a specific oauth client (identified by a valid `clientid`) for auditing access or managing permissions. | action |
CAL_GET_ORGANIZATION_SCHEDULESRetrieves a list of schedules (e. | action |
CAL_GET_ORGANIZATION_TEAMS_EVENT_TYPESRetrieves event types, including names, durations, and custom settings for team scheduling, for all teams within an existing organization specified by `orgid`. | action |
CAL_GET_ORGANIZATION_USER_SCHEDULESFetches all schedule information for a specific user within an organization; handle potential pagination for extensive schedules. | action |
CAL_GET_SCHEDULE_FOR_USER_IN_TEAMFetches all scheduled events or appointments for a specified user within their team and organization. | action |
CAL_GET_STRIPE_CONNECT_INFORetrieves stripe connect account details (id, charges/payouts status, verification, settings) for the user's linked Cal. | action |
CAL_GET_TEAM_DETAILS_BY_ORG_ID_AND_TEAM_IDRetrieves comprehensive details (e. | action |
CAL_GET_TEAM_INFORMATION_BY_TEAM_IDFetches comprehensive details for an existing team using its unique id; returned fields may vary by team configuration and user permissions. | action |
CAL_GET_WEBHOOK_BY_IDRetrieves details for an existing and accessible webhook by its id; this is a read-only operation. | action |
CAL_HANDLE_CONFERENCING_OAUTH_CALLBACK_FOR_APPProcesses an oauth 2. | action |
CAL_LIST_ORGANIZATION_MEMBERSHIPSRetrieves all memberships for a given organization, including user details, roles, status, and membership dates. | action |
CAL_LIST_TEAM_EVENT_TYPES_BY_ORG_AND_TEAM_IDRetrieves all event types for a specific team within an organization, optionally filtering by a specific event slug. | action |
CAL_MARK_BOOKING_ABSENT_FOR_UIDMarks the host and/or specified attendees as absent for an existing booking, typiCally used after a scheduled event to record no-shows. | action |
CAL_MODIFY_ORGANIZATION_MEMBERSHIP_BY_IDUpdates 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 |
CAL_MODIFY_ORG_ATTRIBUTE_BY_IDPartially 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 |
CAL_PATCH_ORGANIZATION_ATTRIBUTE_OPTIONPartially 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 |
CAL_PATCH_ORGANIZATION_USER_DETAILSPartially updates details for a user that exists within the specified organization. | action |
CAL_PATCH_TEAM_DETAILS_BY_IDUpdates specified details for an existing team identified by `teamid`; unspecified fields remain unchanged. | action |
CAL_PATCH_WEBHOOK_EVENT_TYPEUpdates configuration (e. | action |
CAL_POST_CALENDAR_CREDENTIALSUse 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 |
CAL_POST_CONFERENCING_APP_CONNECTConnects or reconnects Cal. | action |
CAL_POST_NEW_BOOKING_REQUESTCreates 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 |
CAL_POST_ORG_ATTRIBUTE_OPTION_BY_USERAssigns 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 |
CAL_POST_SELECTED_CALENDARSLinks 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 |
CAL_POST_USER_TO_ORGANIZATIONAdds a new user to an existing organization (identified by `orgid` in path), requiring user's `email` and allowing extensive optional profile customization. | action |
CAL_POST_WEBHOOK_EVENTCreates a new Cal. | action |
CAL_REASSIGN_BOOKING_TO_ANOTHER_USERReassigns an existing, active booking to a specified, authorized user; does not notify participants of this change. | action |
CAL_REASSIGN_BOOKING_WITH_UIDReassigns the specified booking to a new team member, who is determined by the system rather than being specified in the request. | action |
CAL_REFRESH_OAUTH_TOKEN_FOR_CLIENT_IDRefreshes 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 |
CAL_RESCHEDULE_BOOKING_BY_UIDReschedules an existing booking (identified by `bookinguid`) to a new time, provided the new slot's availability is confirmed beforehand; all other rescheduling parameters (e. | action |
CAL_RETRIEVE_ATTRIBUTE_OPTIONS_FOR_ORGRetrieves all available options for a specific attribute within a designated organization, requiring valid and associated `orgid` and `attributeid`. | action |
CAL_RETRIEVE_BOOKING_DETAILS_BY_UIDFetches comprehensive details for an existing booking, identified by its `bookinguid`. | action |
CAL_RETRIEVE_CURRENT_TEAM_FOR_ORGANIZATIONRetrieves details of the team(s) for the currently authenticated user within the specified organization `orgid`. | action |
CAL_RETRIEVE_DEFAULT_CONFERENCING_SETTINGSRetrieves an account's or organization's read-only default conferencing settings in Cal. | action |
CAL_RETRIEVE_EVENT_TYPE_BY_IDRetrieves comprehensive details for a specific, existing Cal. | action |
CAL_RETRIEVE_MEMBERSHIP_FROM_ORGANIZATIONRetrieves detailed information about a specific membership within a particular organization. | action |
CAL_RETRIEVE_OAUTH_CLIENT_USER_BY_IDRetrieves detailed information for an existing user specifiCally associated with an existing oauth client. | action |
CAL_RETRIEVE_OAUTH_CLIENT_WEBHOOK_BY_IDRetrieves a specific webhook using its `webhookid` and the `clientid` of its associated oauth client. | action |
CAL_RETRIEVE_ORGANIZATION_ATTRIBUTESRetrieves detailed attributes (e. | action |
CAL_RETRIEVE_ORGANIZATION_ATTRIBUTES_OPTIONSFetches 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 |
CAL_RETRIEVE_ORGANIZATION_WEBHOOKS_BY_ORG_IDRetrieves a list of webhooks for an organization specified by `orgid`, supporting pagination; this is a read-only operation. | action |
CAL_RETRIEVE_ORGANIZATION_WEBHOOK_BY_IDRetrieves detailed information, including configuration and status, for a specific webhook by its id (`webhookid`) within a given organization (`orgid`). | action |
CAL_RETRIEVE_PROVIDER_DETAILSRetrieves detailed information for an existing provider in the Cal scheduling system using their unique client id. | action |
CAL_RETRIEVE_SCHEDULES_LISTRetrieves a comprehensive list of all schedules associated with the authenticated user's Cal. | action |
CAL_RETRIEVE_TEAM_DETAILS_IN_ORGANIZATIONRetrieves a paginated list of teams and their details for a specific organization id; individual team member details or schedules are not included. | action |
CAL_RETRIEVE_TEAM_EVENT_TYPESRetrieves event types for a team within the Cal scheduling system; this action does not provide details on scheduled instances or member availability. | action |
CAL_RETRIEVE_TEAM_MEMBERSHIPS_FOR_ORGANIZATIONRetrieves all user memberships, including their roles and states, for a specific team within an organization. | action |
CAL_RETRIEVE_TEAM_MEMBERSHIP_BY_IDRetrieves detailed information, including role and status, for a specific team membership using its id, for a given organization and team. | action |
CAL_RETRIEVE_TEAM_MEMBERSHIP_DETAILSRetrieves 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 |
CAL_RETRIEVE_V2_CONFERENCING_INFORetrieves 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 |
CAL_RETRIEVE_WEBHOOKS_FOR_EVENT_TYPERetrieves 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 |
CAL_RETRIEVE_WEBHOOKS_LISTRetrieves 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 |
CAL_RETRIEVE_WEBHOOK_DETAILS_FOR_OAUTH_CLIENTRetrieves a list of webhooks for a specific oauth client, supporting pagination. | action |
CAL_SAVE_CALENDAR_ENTRYSaves or updates a Calendar's settings using a get request, typiCally for data already on the server or simple updates via query parameters. | action |
CAL_SAVE_CALENDAR_ICS_FEEDSImports and saves one or more publicly accessible external iCalendar (ics) feed urls into the Cal. | action |
CAL_SAVE_OAUTH_CREDENTIALS_VIA_GCAL_APICompletes the google Calendar oauth 2. | action |
CAL_SAVE_STRIPE_DETAILSCompletes 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 |
CAL_SET_DEFAULT_CONFERENCING_APPSets the specified, valid, and configured conferencing application as the default for new meetings for the authenticated user. | action |
CAL_UPDATE_DESTINATION_CALENDAR_INTEGRATIONUpdates the destination Calendar for syncing events, using `integration` and `externalid` (typiCally from `/Calendars` endpoint). | action |
CAL_UPDATE_OAUTH_CLIENT_USER_SETTINGSUpdates 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 |
CAL_UPDATE_OAUTH_CLIENT_WEBHOOKUpdates specified properties of an existing webhook for an oauth client; omitted fields remain unchanged. | action |
CAL_UPDATE_SCHEDULE_BY_IDUpdates an existing schedule by its id, allowing partial modification of properties; providing `availability` or `overrides` replaces them entirely. | action |
CAL_UPDATE_TEAM_INFORMATION_BY_IDUpdates an existing team's information by its id within a specified organization; the `slug`, if provided, must be unique within the organization. | action |
CAL_UPDATE_TEAM_MEMBERSHIP_BY_IDUpdates specified properties (e. | action |
CAL_UPDATE_TEAM_MEMBERSHIP_PROPERTIESUpdates 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 |
CAL_UPDATE_USER_PROFILE_DETAILSUpdates the profile information and preferences for the authenticated user, affecting only the fields provided in the request. | action |
CAL_UPDATE_USER_SCHEDULE_IN_ORGANIZATIONModifies 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 |
CAL_UPDATE_WEBHOOK_BY_IDUpdates an existing Cal. | action |
CAL_UPDATE_WEBHOOK_FOR_ORGANIZATIONUse 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 |