Cal

Parámetros de entrada

• rolestringenum

  Specifies the user's role within the team (e.g., 'MEMBER', 'OWNER', 'ADMIN').

  MEMBEROWNERADMIN
• orgIdintegerObligatorio

  The unique identifier of the organization to which the team belongs.

• teamIdintegerObligatorio

  The unique identifier of the team to which the member will be added.

• userIdintegerObligatorio

  The unique identifier of the user to be added to the team.

• acceptedboolean

  Indicates whether the membership invitation is accepted; `True` for active member, `False` for pending status.

• disableImpersonationboolean

  If `True`, this user cannot be impersonated by administrators or those with impersonation privileges.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the details of the newly created team membership, including user ID, team ID, role, and acceptance status.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• slugstringObligatorio

  URL-friendly identifier for the new option, which must be unique for the attribute within the organization.

• orgIdintegerObligatorio

  Unique identifier of the organization.

• valuestringObligatorio

  Display name for the new option.

• attributeIdstringObligatorio

  Unique identifier of the attribute to which the new option is added.

Parámetros de salida

• dataobjectObligatorio

  Details of the newly created attribute option.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• clientIdstringObligatorio

  Unique identifier of the OAuth client.

• webhookIdstringObligatorio

  Unique identifier of the webhook to be deleted.

Parámetros de salida

• dataobjectObligatorio

  Contains confirmation of the deletion or status information; exact structure may vary.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• bookingUidstringObligatorio

  The unique identifier (UID) of the booking to be cancelled. This UID is generated by Cal.com when a booking is created.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing details of the cancellation. On successful cancellation, this typically includes fields such as `id` (the numeric ID of the booking), `uid` (the unique string identifier of the booking), `status` (which should be 'cancelled'), `cancellationReason`, and `cancelledByEmail`.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• calendarstringObligatorio

  The calendar type to check availability for. Must be one of the supported calendar providers.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the availability information for the requested calendar. The exact structure and content can vary but typically include free/busy time slots or an overall availability status.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Details about the Google Calendar synchronization status, typically including connection status, last synchronization time, and any potential issues.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Results of the ICS feed validation, detailing its validity, accessibility, and any detected errors.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• teamIdstringObligatorio

  The unique identifier of the team whose Stripe integration status needs to be checked.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• bookingUidstringObligatorio

  The unique identifier (UID) of the booking that needs to be confirmed.

Parámetros de salida

• dataobjectObligatorio

  Details of the confirmed booking, such as status and other relevant information; its structure may vary.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• calendarstringObligatorio

  The calendar type to connect to. Must be one of the supported calendar providers.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• rolestringenum

  The role to assign to the user within the organization.

  MEMBEROWNERADMIN
• orgIdintegerObligatorio

  The unique identifier of the organization.

• userIdintegerObligatorio

  The unique identifier of the user to be added or whose membership is to be updated.

• acceptedboolean

  Indicates whether the membership invitation has been accepted by the user.

• disableImpersonationboolean

  If true, disables the ability for this user to be impersonated by others with appropriate permissions.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the details of the created or updated organization membership.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Full name of the new managed user, used in communications and the Cal.com interface.

• emailstringObligatorio

  Email address for the new managed user.

• localestringenum

  User's preferred language and regional settings as a locale code (e.g., 'en', 'es').

  arcadeeseuheidjalvplrosr+30
• clientIdstringObligatorio

  Unique identifier of the OAuth client. This often needs to match the `clientId` in the API path.

• timeZonestring

  IANA timezone (e.g., 'America/New_York') for the user's default schedule (Mon-Fri, 9AM-5PM). For behavior when omitted, see action description; 'Europe/London' may serve as a fallback.

• avatarUrlstring

  Publicly accessible URL for the user's avatar image to be used as their profile picture.

• weekStartstringenum

  Day on which the user's week starts (e.g., 'Monday', 'Sunday').

  MondayTuesdayWednesdayThursdayFridaySaturdaySunday
• timeFormatinteger

  User's preferred time display format: 12 for 12-hour, 24 for 24-hour.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the details of the newly created user, typically including their ID, email, name, and other configured settings.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• activebooleanObligatorio

  A boolean flag indicating whether the webhook should be active upon creation. If true, notifications will be sent immediately for triggered events. If false, the webhook is created in an inactive state.

• secretstring

  An optional secret key used to sign the webhook payloads. This allows your `subscriberUrl` to verify that incoming requests are genuinely from Cal.com. If provided, Cal.com will include an `X-Cal-Signature-256` header in webhook requests.

• clientIdstringObligatorio

  The unique identifier of the OAuth client for which to create the webhook.

• triggersstringObligatorioenum

  The specific event type that will trigger this webhook. Choose one from the available event triggers.

  BOOKING_CREATEDBOOKING_PAYMENT_INITIATEDBOOKING_PAIDBOOKING_RESCHEDULEDBOOKING_REQUESTEDBOOKING_CANCELLEDBOOKING_REJECTEDBOOKING_NO_SHOW_UPDATEDFORM_SUBMITTEDMEETING_ENDEDMEETING_STARTEDRECORDING_READY+6
• subscriberUrlstringObligatorio

  The HTTPS URL to which webhook notifications will be POSTed. This endpoint must be capable of receiving and processing these notifications.

• payloadTemplatestring

  Optional JSON template for the webhook payload. This allows customization of the data sent to the `subscriberUrl`. Refer to Cal.com documentation (cal.com/docs/core-features/webhooks) for details on template syntax and available variables.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the details of the newly created webhook configuration, including its ID, triggers, and status.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  The human-readable display name for the organization attribute.

• slugstringObligatorio

  A unique, URL-friendly identifier for the organization attribute, typically a lowercase version of the name with spaces or special characters replaced by hyphens or underscores. This slug must be unique within the organization.

• typestringObligatorioenum

  The data type of the organization attribute, determining its behavior and storage.

  TEXTNUMBERSINGLE_SELECTMULTI_SELECT
• orgIdintegerObligatorio

  The unique identifier of the organization for which this attribute is being created. This ID is used in the API request path.

• enabledboolean

  Indicates whether the organization attribute is active and usable upon creation. Set to `true` to enable, `false` to disable. If not specified, the system's default behavior for new attributes (e.g., enabled) will apply.

• optionsobject[]Obligatorio

  A list of options for the attribute. This field is always required. For `SINGLE_SELECT` or `MULTI_SELECT` types, this list must contain at least one option definition. For `TEXT` or `NUMBER` types, an empty list `[]` should be provided.

Parámetros de salida

• dataobjectObligatorio

  A dictionary representing the successfully created organization attribute, including its ID, name, slug, type, and other properties.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgIdintegerObligatorio

  Unique identifier for the organization to associate with this webhook.

• activebooleanObligatorio

  If `true`, webhook is active upon creation and sends notifications; `false` creates it disabled.

• secretstring

  Secret used to generate an HMAC SHA256 signature for payloads. If provided, Cal.com sends this signature in the `X-Cal-Signature-256` header, allowing `subscriberUrl` to verify request origin.

• triggersstringObligatorioenum

  Event type that triggers this webhook to send a notification to `subscriberUrl`.

  BOOKING_CREATEDBOOKING_PAYMENT_INITIATEDBOOKING_PAIDBOOKING_RESCHEDULEDBOOKING_REQUESTEDBOOKING_CANCELLEDBOOKING_REJECTEDBOOKING_NO_SHOW_UPDATEDFORM_SUBMITTEDMEETING_ENDEDMEETING_STARTEDRECORDING_READY+6
• subscriberUrlstringObligatorio

  Publicly accessible URL to receive HTTP POST requests for triggered events; this endpoint must process the webhook payloads.

• payloadTemplatestring

  JSON template for the payload sent to `subscriberUrl`. Supports variables for event-specific data (see Cal.com docs at cal.com/docs/core-features/webhooks for syntax and variables).

Parámetros de salida

• dataobjectObligatorio

  Details of the newly created organization webhook.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• biostring

  A short biography or description of the team.

• namestringObligatorio

  The name of the team.

• slugstring

  Unique, URL-friendly identifier for the team. If not provided, may be generated from the name. Used for team page access.

• themestring

  Visual theme for the team's booking page (e.g., 'light', 'dark', 'system').

• appLogostring

  Logo URL for the team within the Cal.com application interface.

• logoUrlstring

  URL of the team's primary logo.

• metadatastring

  JSON string for custom key-value data associated with the team profile.

• timeZonestring

  Default timezone for the team, used for initial schedule setup (e.g., Mon-Fri, 9AM-5PM).

• bannerUrlstring

  URL of the team's banner image for their booking page.

• isPrivateboolean

  If true, the team profile is private and not publicly discoverable without permissions.

• weekStartstring

  Day the week starts for calendar displays (e.g., 'Sunday', 'Monday').

• brandColorstring

  Primary brand color for team pages (hex format, e.g., '#FF5733').

• timeFormatinteger

  Preferred time display format: 12 for 12-hour (e.g., 2:30 PM) or 24 for 24-hour (e.g., 14:30).

• appIconLogostring

  Icon version URL of the team's logo (e.g., for favicons).

• calVideoLogostring

  Logo URL for display during the team's Cal.com video calls.

• hideBrandingboolean

  If true, Cal.com's own branding is hidden on the team's public pages.

• darkBrandColorstring

  Brand color for dark mode (hex format); complements 'brandColor'.

• autoAcceptCreatorboolean

  If true, the team creator is automatically added and accepted as an admin member.

• hideBookATeamMemberboolean

  If true, hides the option to book a specific team member, encouraging collective bookings.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgIdintegerObligatorio

  Unique identifier for an existing organization.

• teamIdintegerObligatorio

  Unique identifier for an existing team.

• calApiKeystringObligatorio

  API key for Cal.com integration.

• guestNamestring

  Name of the guest participating in the call.

• guestEmailstring

  Email address of the guest; can be used for notifications or record-keeping.

• eventTypeIdintegerObligatorio

  Unique identifier for an existing event type.

• beginMessagestring

  Initial message played or displayed when the call begins; useful for providing context or instructions.

• guestCompanystring

  Company affiliation of the guest, if applicable.

• numberToCallstringObligatorio

  Recipient's phone number in E.164 format (e.g., +13105552368), which will be dialed.

• templateTypestringenum

  Template for the phone call event; determines the initial setup and prompts for the call.

  CHECK_IN_APPOINTMENTCUSTOM_TEMPLATE
• generalPromptstring

  General prompt or script to guide the conversation; can set the agenda or provide talking points.

• schedulerNamestring

  Name of the person or entity scheduling the call.

• yourPhoneNumberstringObligatorio

  Your phone number in E.164 format (e.g., +12125552368), used as the caller ID.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the response data from the Cal.com API, typically confirming the creation of the event and including its details.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• teamIdintegerObligatorio

  Identifier of the team under which this phone call event type template will be created.

• calApiKeystringObligatorio

  Cal.com integration API key.

• guestNamestring

  Name of the guest or person being called.

• guestEmailstring

  Guest's email address.

• eventTypeIdintegerObligatorio

  Identifier of the existing event type to associate this phone call template with.

• beginMessagestring

  Optional initial message or script for the beginning of the call.

• guestCompanystring

  Guest's company affiliation, if applicable.

• numberToCallstringObligatorio

  Recipient's phone number in E.164 format (e.g., +12125552368).

• templateTypestringenum

  Specifies template: `CHECK_IN_APPOINTMENT` (predefined) or `CUSTOM_TEMPLATE` (user-defined).

  CHECK_IN_APPOINTMENTCUSTOM_TEMPLATE
• generalPromptstring

  Optional general prompt or script to guide the call's conversation.

• schedulerNamestring

  Name of the scheduler or call initiator (e.g., 'John Doe Scheduling').

• yourPhoneNumberstringObligatorio

  Caller's phone number in E.164 format (e.g., +12125552368).

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the details of the newly created phone call event type template.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• slugstringObligatorio

  A URL-friendly identifier for the event type, typically derived from the title.

• hostsobject[]Obligatorio

  List of hosts; each needs `userId`. `mandatory`/`priority` optional for round-robin.

• seatsobject

  Seat-based availability for multiple attendees per slot. Ex: `{'perSlot': 10, 'attendeeNoun': 'participant', 'showAttendees': True}`.

• titlestringObligatorio

  The title of the event type that will be displayed to bookers.

• teamIdintegerObligatorio

  The unique identifier of the team for which this event type is being created.

• locationsobject[]

  Event locations (e.g., physical, integration links). Defaults to Cal.com video link. Each object specifies type, e.g., {'type': 'integrations:google:meet'} or {'type': 'physical', 'address': '123 Main St'}.

• customNamestring

  Customizable name for the created calendar event. Supports variables like {Event type title}, {Organiser}, {Scheduler}, etc.

• recurrenceobject

  Recurrence rules for the event. Ex: `{'frequency': 'weekly', 'interval': 1, 'count': 10}`.

• scheduleIdinteger

  Overrides team's default schedule with this schedule ID.

• descriptionstring

  Detailed event type description for bookers.

• offsetStartinteger

  Offsets start times of available slots by specified minutes. E.g., 15 min offset shifts 9:00 AM to 9:15 AM.

• slotIntervalinteger

  Duration in minutes for each available time slot (e.g., 30 min intervals for a 60 min event if `lengthInMinutes` is 60). Defaults to `lengthInMinutes` if not specified.

• bookingFieldsobject[]

  Custom fields for the booking form (name and email are default). Each object defines a field, e.g., {'name': 'company_name', 'type': 'text', 'label': 'Company Name', 'required': True}.

• bookingWindowobject

  Future booking window. Ex: `{'start': 0, 'end': 30, 'unit': 'days'}`.

• disableGuestsboolean

  If true, booker cannot add additional guests via email.

• lengthInMinutesintegerObligatorio

  The default duration of the event in minutes.

• afterEventBufferinteger

  Buffer time (minutes) after events (marked unavailable).

• beforeEventBufferinteger

  Buffer time (minutes) before events (marked unavailable).

• hideCalendarNotesboolean

  If true, hide calendar notes (description, location, etc.) from created event.

• bookingLimitsCountobject

  Limits on booking frequency. Ex: `{'count': 10, 'period': 'day'}`.

• confirmationPolicyobject

  Booking confirmation policy. Ex: `{'type': 'MANUAL', 'message': 'Your booking requires manual approval.'}`.

• successRedirectUrlstring

  Redirect URL after successful booking. Defaults to Cal.com page.

• color__darkThemeHexstring

  Hex color for dark theme display (e.g., '#4A90E2').

• assignAllTeamMembersboolean

  If true, assign all current and future team members as hosts.

• color__lightThemeHexstring

  Hex color for light theme display (e.g., '#FFD700').

• minimumBookingNoticeinteger

  Minimum minutes notice required for booking.

• bookingLimitsDurationobject

  Limits on total booking duration per period. Ex: `{'duration': 120, 'period': 'week'}`.

• lengthInMinutesOptionsstring[]Obligatorio

  Alternative event durations in minutes for bookers; must include `lengthInMinutes`.

• hideCalendarEventDetailsboolean

  If true, hide event details (attendees, description) from non-organizer attendees.

• onlyShowFirstAvailableSlotboolean

  If true, show only the earliest available slot per day.

• useDestinationCalendarEmailboolean

  If true, use destination calendar's email for event invites/updates.

• destinationCalendar__externalIdstring

  External ID for destination calendar. See `/api/v2/calendars`.

• lockTimeZoneToggleOnBookingPageboolean

  If true, lock timezone toggle on booking page.

• requiresBookerEmailVerificationboolean

  If true, bookers must verify email before confirmation.

• destinationCalendar__integrationstring

  Integration type for destination calendar (e.g., 'google_calendar'). See `/api/v2/calendars`.

Parámetros de salida

• dataobjectObligatorio

  The details of the newly created team event type.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• slugstringObligatorio

  A URL-friendly identifier for the event type. Usually a hyphenated version of the title.

• hostsobject[]Obligatorio

  List of hosts. Each specifies user ID and optionally mandatory status/priority (for round-robin). At least one host required.

• orgIdintegerObligatorio

  The unique identifier for the organization.

• seatsobject

  Defines seat-based availability, allowing multiple attendees per slot. Example: `{"enabled": true, "per_slot": 10, "show_remaining_seats": true, "attendee_questions": [{"name": "department", "label": "Department", "type": "text", "required": false}]}`.

• titlestringObligatorio

  The title of the event type.

• teamIdintegerObligatorio

  The unique identifier for the team.

• locationsobject[]

  A list of physical or virtual locations for the event. If not provided, a Cal.com video link will be used by default. Example: `[{"type": "cal_video"}, {"type": "address", "address": "123 Main St, Anytown, USA"}]`

• customNamestring

  Customizable name for the calendar event entry. Supports variables like {Event type title}, {Organiser}, etc. Refer to Cal.com documentation for the full list.

• recurrenceobject

  Defines the recurrence pattern for recurring events. Example: `{"frequency": "weekly", "interval": 1, "count": 10}` (weekly for 10 occurrences) or `{"frequency": "daily", "until": "2024-12-31T23:59:59Z"}`.

• scheduleIdinteger

  The ID of a specific schedule to use for this event type, overriding the team's or user's default schedule.

• descriptionstring

  A detailed description of the event type. Can include HTML for formatting.

• offsetStartinteger

  Offset (minutes) to shift display of available slots. For example, an offset of 15 means a 9:00 AM slot shows as 9:15 AM.

• slotIntervalinteger

  Duration in minutes of each bookable time slot. For example, if `lengthInMinutes` is 60 and `slotInterval` is 30, slots like 9:00, 9:30, 10:00 will be shown for the 60-minute event. Defaults to `lengthInMinutes` if not specified.

• bookingFieldsobject[]

  A list of custom fields for the booking form. By default, the form includes name and email fields. Example: `[{"name": "company_size", "label": "Company Size", "type": "select", "options": ["1-10", "11-50"], "required": false}]`

• bookingWindowobject

  Defines how far in the future this event can be booked. Example: `{"type": "rolling_days", "days": 30}` (up to 30 days in advance) or `{"type": "date_range", "startDate": "2024-01-01T00:00:00Z", "endDate": "2024-03-31T23:59:59Z"}`.

• disableGuestsboolean

  If true, the person booking this event cannot add guests via their email addresses.

• lengthInMinutesintegerObligatorio

  The default duration of the event in minutes.

• afterEventBufferinteger

  Buffer time in minutes to add after each event. This time will be blocked out in the calendar.

• beforeEventBufferinteger

  Buffer time in minutes to add before each event. This time will be blocked out in the calendar.

• hideCalendarNotesboolean

  If true, any notes added to the calendar event by the organizer will be hidden from the booker.

• bookingLimitsCountobject

  Defines limits on how many times this event can be booked per period. Example: `{"period": "day", "count": 1}` (one per day) or `{"period": "rolling_days_period", "count": 2, "days": 7}` (2 per rolling 7 days).

• confirmationPolicyobject

  Specifies the manual confirmation policy for bookings. Example: `{"type": "manual_confirmation", "threshold_period": "24h", "threshold_bookings": 10}` or `{"type": "automatic_confirmation"}`.

• successRedirectUrlstring

  A valid URL to which the booker will be redirected after a successful booking.

• color__darkThemeHexstring

  Hexadecimal color code for the event type when displayed in a dark theme (e.g., '#FF6347' for tomato red).

• assignAllTeamMembersboolean

  If true, all current and future members of the team will automatically be assigned as hosts to this event type. If set, the `hosts` list can be empty or will be supplemented.

• color__lightThemeHexstring

  Hexadecimal color code for the event type when displayed in a light theme (e.g., '#FF0000' for red).

• minimumBookingNoticeinteger

  The minimum number of minutes before the event's start time that a booking can be made.

• bookingLimitsDurationobject

  Defines limits on total booked duration (minutes) for this event type per period. Example: `{"period": "week", "duration": 120}` (120 minutes per week).

• lengthInMinutesOptionsstring[]Obligatorio

  Alternative event durations (strings, in minutes). The value of `lengthInMinutes` (converted to a string) must be included in this list.

• hideCalendarEventDetailsboolean

  If true, sensitive details of the calendar event (like attendee list or full description) might be hidden or summarized for bookers.

• onlyShowFirstAvailableSlotboolean

  If true, only the earliest available slot per day will be displayed to bookers for this event type.

• useDestinationCalendarEmailboolean

  If true, the email address associated with the destination calendar will be used for sending event notifications, overriding the user's primary email if different.

• destinationCalendar__externalIdstring

  External ID of the specific calendar for new bookings. Obtain from `/api/v2/calendars`.

• lockTimeZoneToggleOnBookingPageboolean

  If true, the booker will not be able to change the timezone on the booking page; it will be locked to the event type's timezone.

• requiresBookerEmailVerificationboolean

  If true, bookers will be required to verify their email address before the booking is confirmed.

• destinationCalendar__integrationstring

  Integration type of the calendar for new bookings (e.g., 'google_calendar'). Obtain from `/api/v2/calendars`.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the full details of the newly created team event type.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• biostring

  Short description or biography for the team.

• namestringObligatorio

  Name of the team to be created.

• slugstring

  Unique, URL-friendly identifier for the team (e.g., 'marketing-team'). Auto-generated from name if not provided.

• orgIdintegerObligatorio

  ID of the organization where the team will be created.

• themestring

  Visual theme for the team's booking page (e.g., 'light', 'dark', 'system', or custom).

• appLogostring

  URL for the logo displayed within the Cal.com application interface for this team.

• logoUrlstring

  URL of the team's logo image, displayed on its booking page and profile.

• metadatastring

  JSON string for custom key-value pairs to store additional team information.

• timeZonestring

  IANA time zone identifier (e.g., 'America/New_York') for the team's default schedule. Defaults to 'Europe/London'.

• bannerUrlstring

  URL of the team's banner image, displayed at the top of its booking page.

• isPrivateboolean

  If true, the team is private, not publicly discoverable, and access is restricted.

• weekStartstring

  First day of the week for calendar displays (e.g., 'Sunday', 'Monday'). Defaults to 'Sunday'.

• brandColorstring

  Primary brand color for the team (CSS-valid string, e.g., '#FF5733' or 'blue').

• timeFormatinteger

  Preferred time format: 12 for 12-hour (e.g., 1:00 PM), 24 for 24-hour (e.g., 13:00).

• appIconLogostring

  URL for a smaller icon version of the team's logo for contexts like list views or notifications.

• calVideoLogostring

  URL for the team's video logo, displayed during Cal Video sessions.

• hideBrandingboolean

  If true, hides Cal.com's default branding on the team's booking pages for a white-labeled experience.

• darkBrandColorstring

  Brand color for dark theme on the team's booking page (CSS-valid string).

• autoAcceptCreatorboolean

  If true, the team creator is automatically accepted as a member. Defaults to true.

• hideBookATeamMemberboolean

  If true, hides the option to book a specific team member from the team's main booking page.

Parámetros de salida

• dataobjectObligatorio

  Complete details of the newly created team, including its unique ID and all applied settings.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• rolestringenum

  The role to assign to the user within the team.

  MEMBEROWNERADMIN
• teamIdintegerObligatorio

  The unique identifier of the team to which the user will be added.

• userIdintegerObligatorio

  The unique identifier of the user to be added to the team.

• acceptedboolean

  Indicates if the membership invitation is pre-accepted. If `true`, the user is added directly to the team without needing to accept an invitation.

• disableImpersonationboolean

  If `true`, prevents administrators from impersonating this user.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the details of the newly created team membership.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Descriptive name for the availability schedule (e.g., 'Working Hours', 'Holiday Schedule').

• timeZonestringObligatorio

  IANA timezone identifier (e.g., 'America/New_York'). Essential for correct event availability calculation.

• isDefaultbooleanObligatorio

  Sets this as the user's default schedule if true, replacing any existing default. The default schedule is used for event types not linked to a specific one. Each user must have exactly one default schedule.

• overridesobject[]

  List of override objects for specific date exceptions (e.g., holidays). Overrides take precedence over weekly availability.

• availabilityobject[]

  List of availability objects defining active days and time slots. If omitted, a default (Mon-Fri, 09:00-17:00 in schedule's timeZone) is applied.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the details of the newly created availability schedule.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestringObligatorio

  Descriptive name for the schedule.

• orgIdintegerObligatorio

  Unique identifier of the organization.

• userIdintegerObligatorio

  Unique identifier of the user for whom the schedule is created.

• timeZonestringObligatorio

  IANA timezone identifier for the schedule (e.g., 'America/New_York'); used to calculate event times.

• isDefaultbooleanObligatorio

  Specifies if this is the user's default schedule. Only one schedule can be default; used for event types not tied to a specific schedule.

• overridesobject[]

  List of overrides to change availability for specific dates (e.g., holidays, special events).

• availabilityobject[]

  List of availability objects defining the user's regular weekly schedule. If omitted, system may assume a default (e.g., Mon-Fri, 09:00-17:00).

Parámetros de salida

• dataobjectObligatorio

  Details of the newly created schedule.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• activebooleanObligatorio

  Indicates if the webhook is active.

• secretstring

  Secret key to sign the webhook payload, allowing verification of Cal.com origin.

• triggersstringObligatorioenum

  Specific event that triggers the webhook.

  BOOKING_CREATEDBOOKING_PAYMENT_INITIATEDBOOKING_PAIDBOOKING_RESCHEDULEDBOOKING_REQUESTEDBOOKING_CANCELLEDBOOKING_REJECTEDBOOKING_NO_SHOW_UPDATEDFORM_SUBMITTEDMEETING_ENDEDMEETING_STARTEDRECORDING_READY+6
• eventTypeIdintegerObligatorio

  Unique identifier for the event type.

• subscriberUrlstringObligatorio

  URL to receive webhook payloads for trigger events; must handle POST requests.

• payloadTemplatestring

  String template for the payload sent to `subscriberUrl`, allowing variables like {{type}}. Refer to cal.com/docs/core-features/webhooks for more details.

Parámetros de salida

• dataobjectObligatorio

  Details of the created webhook (e.g., ID, URL, configuration).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• reasonstring

  Reason provided by the host for declining the booking; recommended for clear communication with the attendee.

• bookingUidstringObligatorio

  The unique identifier (UID) of the booking to be declined.

Parámetros de salida

• dataobjectObligatorio

  API response, typically confirming successful declination or providing error details if the operation failed.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• appstringObligatorio

  Identifier for the conferencing application to be disconnected. This is typically the unique name or slug of the app integration in Cal.com.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the result of the disconnection operation. This may include a success status or an empty object upon successful disconnection.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• eventTypeIdintegerObligatorio

  The unique numerical identifier of the event type to be deleted.

Parámetros de salida

• dataobjectObligatorio

  Response data from the delete operation. May include a success confirmation or be empty if the API returns no content on successful deletion.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• teamIdintegerObligatorio

  The unique identifier for the team from which the event type will be deleted.

• eventTypeIdintegerObligatorio

  The unique identifier for the event type that is to be deleted from the specified team.

Parámetros de salida

• dataobjectObligatorio

  Typically empty upon successful deletion (204 No Content), but may contain details for errors or other scenarios.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgIdintegerObligatorio

  The unique identifier for the organization in which the team resides.

• teamIdintegerObligatorio

  The unique identifier for the team from which the membership will be deleted.

• membershipIdintegerObligatorio

  The unique identifier for the membership entry to be deleted.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the response from the API, typically indicating the status of the deletion operation.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• userIdintegerObligatorio

  Identifier of the user.

• clientIdstringObligatorio

  Identifier of the OAuth client.

Parámetros de salida

• dataobjectObligatorio

  Data returned upon processing the deletion request; may include a status message or be empty on success.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgIdintegerObligatorio

  The unique identifier of the organization from which the attribute will be deleted.

• attributeIdstringObligatorio

  The unique identifier of the attribute to be deleted from the specified organization.

Parámetros de salida

• dataobjectObligatorio

  Confirms the deletion, possibly an empty object or including a status message.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgIdintegerObligatorio

  The unique identifier for the organization.

• optionIdstringObligatorio

  The unique identifier for the option to be deleted from the attribute.

• attributeIdstringObligatorio

  The unique identifier for the attribute associated with the organization.

Parámetros de salida

• dataobjectObligatorio

  Contains data confirming the deletion or providing status information.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgIdintegerObligatorio

  The unique identifier of the organization from which the membership will be removed.

• membershipIdintegerObligatorio

  The unique identifier of the membership to be deleted.

Parámetros de salida

• dataobjectObligatorio

  A dictionary that may contain a confirmation of the deletion. Often, this will be an empty object or a simple success status, as detailed information about the deleted membership is not typically returned.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgIdintegerObligatorio

  The unique identifier of the organization to which the webhook belongs.

• webhookIdstringObligatorio

  The unique identifier of the webhook to be deleted.

Parámetros de salida

• dataobjectObligatorio

  A dictionary that may contain details about the deletion operation or confirmation. The structure can vary.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• scheduleIdintegerObligatorio

  The unique identifier of the schedule to be deleted.

Parámetros de salida

• dataobjectObligatorio

  Response data from the delete operation; may be empty for successful deletions or contain a confirmation/status.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• externalIdstringObligatorio

  The unique identifier of the calendar as recognized by the external integration provider (e.g., a Google Calendar ID or an Outlook Calendar primary key).

• integrationstringObligatorio

  Identifier for the calendar integration provider, specifying the type of the external calendar system.

• credentialIdstringObligatorio

  The unique identifier for the set of credentials used to authenticate and access the specified calendar integration for this user.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• uidstringObligatorio

  The unique identifier (UID) of the time slot to be deleted.

Parámetros de salida

• dataobjectObligatorio

  A dictionary potentially containing results of the deletion, such as a confirmation message or status. The specific structure and content of this dictionary can vary based on the operation's outcome.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• teamIdintegerObligatorio

  The unique identifier of the team to be deleted.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgIdintegerObligatorio

  Unique identifier of the organization.

• teamIdintegerObligatorio

  Unique identifier of the team to be deleted.

Parámetros de salida

• dataobjectObligatorio

  Indicates the success or status of the deletion, often an empty object or a confirmation message.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• teamIdintegerObligatorio

  The unique identifier of the team from which the membership will be removed.

• membershipIdintegerObligatorio

  The unique identifier of the specific team membership record to be deleted.

Parámetros de salida

• dataobjectObligatorio

  Contains confirmation or status of the team membership deletion; its structure may vary.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgIdintegerObligatorio

  Identifier of the organization containing the user.

• userIdintegerObligatorio

  Identifier for the user.

• attributeOptionIdstringObligatorio

  Identifier of the attribute option (e.g., a specific skill or role) to remove from the user.

Parámetros de salida

• dataobjectObligatorio

  Dictionary typically confirming the successful removal of the attribute option.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgIdintegerObligatorio

  The unique identifier of the organization from which the user will be removed.

• userIdintegerObligatorio

  The unique identifier of the user to be removed from the organization.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the response data from the delete operation, typically confirming success.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgIdintegerObligatorio

  Specifies the organization to which the user and schedule belong.

• userIdintegerObligatorio

  Specifies the user whose schedule is to be deleted.

• scheduleIdintegerObligatorio

  Specifies the schedule to be deleted.

Parámetros de salida

• dataobjectObligatorio

  Typically empty or contains a success confirmation; the deleted schedule's data is not returned.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• webhookIdstringObligatorio

  The unique identifier of the webhook to be deleted.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the API response. For a successful deletion, this might be an empty object or a simple confirmation. In case of an error, it will contain error details.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• webhookIdstringObligatorio

  The unique identifier of the webhook configuration to be deleted.

• eventTypeIdintegerObligatorio

  The unique identifier of the event type from which the webhook will be deleted.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• eventTypeIdintegerObligatorio

  The unique identifier of the event type for which all associated webhooks will be deleted.

Parámetros de salida

• dataobjectObligatorio

  Contains status information about the deletion. Specific content can vary (e.g., an empty object or success confirmation), and details of the deleted webhooks are not included.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idintegerObligatorio

  Unique numeric credential ID for the calendar integration to be disconnected, usually obtained from an endpoint listing connected calendars.

• calendarstringObligatorio

  Identifier for the calendar to be disconnected, typically the provider name (e.g., 'google', 'outlook') or a service-specific calendar name.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the response from the server, usually indicating the status or outcome of the disconnection request.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• skipinteger

  Number of bookings to skip from the beginning of results (for pagination).

• takeinteger

  Maximum number of bookings to return (for pagination).

• statusstring[]

  Filter bookings by status. Provide a list of status values (e.g., `["upcoming", "past"]`).

• teamIdstring

  Filter bookings by a single team ID of which the user is a member.

• sortEndstringenum

  Sort results by booking end time.

  ascdesc
• teamsIdsstring

  Filter bookings by one or more team IDs (comma-separated string) of which the user is a member.

• beforeEndstring

  Filter bookings ending before this ISO 8601 date or date-time string.

• sortStartstringenum

  Sort results by booking start time.

  ascdesc
• afterStartstring

  Filter bookings starting after this ISO 8601 date or date-time string.

• eventTypeIdstring

  Filter bookings by a single event type ID belonging to the user.

• sortCreatedstringenum

  Sort results by booking creation time.

  ascdesc
• attendeeNamestring

  Filter bookings by the name of an attendee.

• eventTypeIdsstring

  Filter bookings by one or more event type IDs (comma-separated string) belonging to the user.

• attendeeEmailstring

  Filter bookings by the exact email address of an attendee.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgIdintegerObligatorio

  The unique identifier of the organization to which the event type belongs.

• teamIdintegerObligatorio

  The unique identifier of the team, within the specified organization, to which the event type belongs.

• eventTypeIdintegerObligatorio

  The unique identifier of the specific event type for which details are to be fetched.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the detailed attributes and configuration of the fetched event type. The structure of this dictionary is dynamic and depends on the specific event type's settings and custom fields.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgIdintegerObligatorio

  The unique numerical identifier of the organization.

• attributeIdstringObligatorio

  The unique string identifier of the specific attribute to retrieve for the organization (e.g., 'industry', 'employee_count', 'custom_field_xyz').

Parámetros de salida

• dataobjectObligatorio

  A dictionary representing the data of the fetched attribute. The structure and content will depend on the specific attribute retrieved.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• clientIdstringObligatorio

  The unique identifier of the Cal API provider or client application for which to fetch the access token.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the access token (e.g., under a key like 'access_token') and potentially other authentication-related details from the Cal API provider. The specific contents can vary depending on the provider.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• scheduleIdintegerObligatorio

  Unique identifier of the schedule to retrieve.

Parámetros de salida

• dataobjectObligatorio

  Comprehensive data for the specified schedule, including details like event information, time slots, and associated metadata.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgIdintegerObligatorio

  Identifier for the organization.

• userIdintegerObligatorio

  Identifier for the user.

• scheduleIdintegerObligatorio

  Identifier for the specific schedule.

Parámetros de salida

• dataobjectObligatorio

  User's schedule details, such as events, availability, and time slots.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• webhookIdstringObligatorio

  Unique identifier for the webhook.

• eventTypeIdintegerObligatorio

  Unique identifier for the event type.

Parámetros de salida

• dataobjectObligatorio

  Detailed information about the fetched webhook, including its target URL, subscribed events, and current status.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• userIdintegerObligatorio

  Unique numerical identifier of the user.

• clientIdstringObligatorio

  Unique string identifier of the OAuth client application.

Parámetros de salida

• dataobjectObligatorio

  Dictionary with the newly refreshed OAuth tokens, typically including `access_token`, `refresh_token`, `token_type`, and `expires_in`.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• endTimestringObligatorio

  End date and time in UTC (ISO 8601 format) until which to fetch available slots. Must be after `startTime`.

• orgSlugstring

  The slug identifying the organization to which the event type or users belong. This can be used to scope the availability search within a specific organization.

• durationinteger

  The desired duration of the time slots in minutes. This is typically used for dynamic events where the slot length is not fixed by the event type.

• timeZonestring

  The IANA time zone identifier (e.g., 'America/New_York', 'Europe/Berlin', 'UTC') in which the available slots should be calculated and returned. If omitted, a default timezone may apply.

• startTimestringObligatorio

  Start date and time in UTC (ISO 8601 format) from which to fetch available slots. Must be before `endTime`.

• slotFormatstringenum

  Determines the format of the returned slot times. Use "range" to get start and end times for each slot; use "time" to get only the start times.

  rangetime
• eventTypeIdintegerObligatorio

  Unique numeric identifier for the event type.

• usernameListstring[]

  Required for dynamic or collective event types to specify the users whose availability should be considered.

• eventTypeSlugstring

  The URL-friendly string identifier (slug) of the event type. Can be used as an alternative to `eventTypeId`.

• rescheduleUidstring

  The unique identifier of an existing booking that is being rescheduled. Providing this helps find slots suitable for the reschedule context.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the available time slots. The exact structure of this dictionary may vary and typically includes a list of slots, where each slot can be a start time or a time range (start and end time) depending on the `slotFormat` request parameter.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• appstringObligatorio

  The identifier of the conferencing application (e.g., 'zoom', 'google_meet'). This is used as a path parameter.

• returnTostringObligatorio

  The URL to which the user will be redirected after successful OAuth authorization.

• onErrorReturnTostringObligatorio

  The URL to which the user will be redirected if an error occurs during the OAuth authorization process.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the generated OAuth authorization URL and potentially other related data. The primary key is typically 'url' holding the authorization link.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Default schedule configuration for the Cal system, including all settings and parameters.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• teamIdintegerObligatorio

  The unique identifier for the team.

• eventTypeIdintegerObligatorio

  The unique identifier for the event type. Must be an event type associated with the provided `teamId`.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• limitinteger

  The maximum number of user records to return. If not specified, a default limit may be applied by the server.

• clientIdstringObligatorio

  The unique identifier of the OAuth client for which to retrieve associated users.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the response data, typically including a list of users associated with the specified OAuth client. Each user object may contain basic details.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• datastring[]

  List of organization IDs the user belongs to.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• skipinteger

  The number of schedules to skip before returning results. Used for pagination.

• takeinteger

  The maximum number of schedules to return. Used for pagination.

• orgIdintegerObligatorio

  The unique identifier of the organization for which to retrieve schedules.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the schedules data for the specified organization. The exact structure of the schedule objects within this dictionary may vary.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• skipinteger

  The number of event types to skip before starting to return results from the list. Used for pagination.

• takeinteger

  The maximum number of event types to return in a single response. Used for pagination.

• orgIdintegerObligatorio

  The unique identifier of the organization for which to retrieve team event types.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the response data. This typically includes a list of event types associated with the organization's teams, with details such as name, duration, and custom settings for each event type.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgIdintegerObligatorio

  The unique identifier for the organization.

• userIdintegerObligatorio

  The unique identifier for the user whose schedules are to be retrieved.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the user's schedule information, such as availability and booked events.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgIdintegerObligatorio

  Unique identifier for the organization.

• teamIdintegerObligatorio

  Unique identifier for the team.

• userIdintegerObligatorio

  Unique identifier for the user.

Parámetros de salida

• dataobjectObligatorio

  User's schedule data; structure may vary based on the scheduling system.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgIdintegerObligatorio

  The unique identifier of the organization to which the team belongs.

• teamIdintegerObligatorio

  The unique identifier of the team for which details are to be retrieved.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• teamIdintegerObligatorio

  The unique numeric identifier of the team for which information is to be retrieved.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the detailed information for the specified team. The exact keys and values depend on the team's configuration and available data, but may include team name, member list, and settings.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• webhookIdstringObligatorio

  The unique identifier of the webhook to retrieve.

Parámetros de salida

• dataobjectObligatorio

  Detailed information of the webhook, including configuration, status, target URL, subscribed events, and last triggered timestamp.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• appstringObligatorio

  Unique identifier for the conferencing application (e.g., 'zoom', 'google_meet', 'msteams'); typically part of the callback URL path.

• codestringObligatorio

  Authorization code from the conferencing application's OAuth provider.

• statestringObligatorio

  OAuth state parameter for CSRF protection, which must match the state sent in the initial authorization request.

Parámetros de salida

• dataobjectObligatorio

  Data from the conferencing provider, typically including access tokens, refresh tokens, expiry information, and user details; specific contents vary by `app`.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgIdinteger

  The unique identifier (ID) of the user's organization. If provided, `orgSlug` is not required. Fetches event types associated with this organization.

• orgSlugstring

  The slug of the user's organization. If provided, `orgId` is not required. Fetches event types associated with this organization.

• usernamestring

  The username of the user whose event types are to be retrieved. If provided alone, fetches all event types for this user.

• eventSlugstring

  The slug of a specific event type to retrieve. If provided, `username` must also be supplied, as multiple users can have events with the same slug.

• usernamesstring

  A comma-separated string of usernames to retrieve dynamic event types for multiple users simultaneously (e.g., 'alice,bob').

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the API response. This typically includes a collection of event types, where each event type object may contain details such as its ID, name, slug, description, duration, and other relevant configurations.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• skipinteger

  The number of initial membership records to skip. If not provided, no records are skipped. Useful for pagination.

• takeinteger

  The maximum number of membership records to return. If not provided, a default limit may apply. Useful for pagination.

• orgIdintegerObligatorio

  The unique identifier of the organization for which to list memberships.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the response from the API. This typically includes a list of organization memberships, where each membership provides details such as user information, roles, membership status (e.g., active, pending, invited), and relevant dates. The exact structure of this dictionary may vary based on the API's implementation but is expected to contain the membership data.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgIdintegerObligatorio

  The unique identifier of the organization to which the team belongs.

• teamIdintegerObligatorio

  The unique identifier of the team whose event types are to be listed.

• eventSlugstring

  Optional slug of a specific team event type. If provided, filters results to the matching event type.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing a collection of team event types, including details like name, slug, and duration.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• hostboolean

  If true, marks the host as absent. If null or omitted, host attendance status is unchanged.

• attendeesobject[]

  List of attendees to mark as absent. If null or omitted, no listed attendees are marked absent.

• bookingUidstringObligatorio

  Unique identifier (UID) for the booking.

Parámetros de salida

• dataobjectObligatorio

  Outcome of the mark-absent operation, typically confirming the update.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• rolestringenum

  New role for the member; if omitted, role is unchanged.

  MEMBEROWNERADMIN
• orgIdintegerObligatorio

  Organization's unique identifier (from URL path).

• acceptedboolean

  Set true to accept membership, false to decline/revoke; if omitted, status is unchanged.

• membershipIdintegerObligatorio

  Membership's unique identifier to modify (from URL path).

• disableImpersonationboolean

  Set true to disable impersonation, false to enable; if omitted, setting is unchanged.

Parámetros de salida

• dataobjectObligatorio

  Details of the modified organization membership.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestring

  The new name for the attribute.

• slugstring

  The new URL-friendly slug for the attribute.

• typestringenum

  The new type for the attribute; changing the type may affect existing data associated with this attribute.

  TEXTNUMBERSINGLE_SELECTMULTI_SELECT
• orgIdintegerObligatorio

  The unique identifier for the organization.

• enabledboolean

  Specifies whether the attribute should be enabled or disabled.

• attributeIdstringObligatorio

  The unique identifier for the attribute to be modified.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the updated details of the organization attribute.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• slugstring

  The new programmatic identifier (slug) for the attribute option, typically used in URLs or API interactions.

• orgIdintegerObligatorio

  The unique identifier of the organization.

• valuestring

  The new display value for the attribute option.

• optionIdstringObligatorio

  The unique identifier of the attribute option to be updated.

• attributeIdstringObligatorio

  The unique identifier of the attribute whose option is being updated.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the data of the successfully updated attribute option.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgIdintegerObligatorio

  The unique identifier of the organization.

• userIdintegerObligatorio

  The unique identifier of the user whose details are to be updated.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the updated user details. The specific structure may vary based on the fields updated and the API's response format.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• biostring

  Short biography or description for the team.

• namestring

  The new name for the team.

• slugstring

  Unique URL-friendly identifier for the team; auto-generated from team name if not provided.

• themestring

  Color theme for team booking pages (e.g., 'light', 'dark', custom).

• teamIdintegerObligatorio

  The unique identifier of the team to be updated.

• appLogostring

  URL for the logo in the Cal.com application for this team.

• logoUrlstring

  URL of the team's logo image.

• metadatastring

  Custom metadata for the team (JSON string or object).

• timeZonestring

  IANA time zone (e.g., 'America/New_York'); affects default schedule, defaults to 'Europe/London'.

• bannerUrlstring

  URL of the team's banner image for their booking page.

• isPrivateboolean

  If true, team is private and not publicly discoverable.

• weekStartstring

  Start day of the week for team calendar views (e.g., 'Sunday').

• brandColorstring

  Primary brand color for the team (CSS color format).

• timeFormatinteger

  Preferred time format: 12 for 12-hour, 24 for 24-hour.

• appIconLogostring

  URL for the icon logo in the application, typically smaller than appLogo.

• calVideoLogostring

  URL for the logo in Cal Video sessions for this team.

• hideBrandingboolean

  If true, hides Cal.com branding on team booking pages.

• bookingLimitsstring

  Team booking limits, like max per day/week (JSON string or object).

• darkBrandColorstring

  Brand color for dark theme (CSS color format).

• hideBookATeamMemberboolean

  If true, hides booking specific team members, forcing team-level bookings (e.g., round-robin).

• includeManagedEventsInLimitsboolean

  If true, team-managed events (round-robin, collective) count towards booking limits.

Parámetros de salida

• dataobjectObligatorio

  Dictionary containing updated team details.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• activeboolean

  Set `true` to activate or `false` to deactivate the webhook.

• secretstring

  Secret key to sign webhook payloads, verifying their origin.

• triggersstringenum

  Specific event that triggers the webhook.

  BOOKING_CREATEDBOOKING_PAYMENT_INITIATEDBOOKING_PAIDBOOKING_RESCHEDULEDBOOKING_REQUESTEDBOOKING_CANCELLEDBOOKING_REJECTEDBOOKING_NO_SHOW_UPDATEDFORM_SUBMITTEDMEETING_ENDEDMEETING_STARTEDRECORDING_READY+6
• webhookIdstringObligatorio

  Unique identifier of the webhook to be updated (path parameter).

• eventTypeIdintegerObligatorio

  Unique identifier of the event type for the webhook (path parameter).

• subscriberUrlstring

  URL where webhook notifications are sent.

• payloadTemplatestring

  Template for the payload sent to `subscriberUrl`. See Cal.com documentation (cal.com/docs/core-features/webhooks) for syntax and variables.

Parámetros de salida

• dataobjectObligatorio

  Configuration of the updated webhook.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• calendarstringObligatorio

  The calendar type for which credentials will be posted. Must be one of the supported calendar providers.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the response from the credential submission. This typically includes status information or details related to the newly established or updated credentials. The exact structure can vary based on the operation's success and the calendar provider.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• appstringObligatorio

  Identifier of the conferencing application for establishing its connection with Cal.com.

Parámetros de salida

• dataobjectObligatorio

  Response data from the conferencing app detailing the outcome of the connection attempt; structure varies.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• startstringObligatorio

  The start date and time for the booking, preferably in ISO 8601 format (e.g., '2024-09-15T10:00:00Z').

• guestsstring[]

  Optional list of guest email addresses or other identifiers to be invited to the event.

• attendeeobjectObligatorio

  A dictionary containing details of the primary attendee. Common keys might include 'name', 'email', and 'timeZone'.

• locationobject

  Optional dictionary specifying the location of the event. Structure may vary (e.g., a physical address or a video call link like {'type': 'GoogleMeet'}).

• metadataobject

  Optional dictionary for any custom metadata associated with the booking. This can be used to store additional information not covered by other fields.

• eventTypeIdintegerObligatorio

  The unique identifier of the event type to be booked.

• lengthInMinutesinteger

  Optional duration of the event in minutes. If not provided, the default length of the event type might be used.

• bookingFieldsResponsesobject

  Optional dictionary containing responses to custom booking fields defined for the event type.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgIdintegerObligatorio

  The unique identifier for the organization.

• valuestring

  Value for a new attribute option to be created under `attributeId` and then assigned to the user; use this if not assigning an existing option via `attributeOptionId`.

• userIdintegerObligatorio

  The unique identifier for the user within the organization.

• attributeIdstringObligatorio

  The unique identifier of the attribute to which this option belongs or will be added and assigned.

• attributeOptionIdstring

  Identifier of an existing attribute option to be assigned to the user for `attributeId`; use this if not creating a new one using `value`.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• externalIdstringObligatorio

  Unique identifier of the specific calendar within the external service.

• integrationstringObligatorio

  Specifies the external calendar system to connect with.

• credentialIdintegerObligatorio

  Unique identifier for the stored credential authorizing Cal's access to the external calendar service.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• emailstringObligatorio

  Email address of the user.

• orgIdintegerObligatorio

  Unique identifier of the organization.

• themestring

  Preferred visual theme for the application.

• localestring

  Preferred language and regional settings.

• weekdaystring

  Preferred start day of the week for calendar views.

• appThemestring

  Preferred application-specific theme with granular styling options.

• timeZonestring

  Preferred time zone (IANA Time Zone Database format).

• usernamestring

  Desired username.

• avatarUrlstring

  URL for the user's avatar image.

• autoAcceptboolean

  If true, user automatically accepts event invitations.

• brandColorstring

  Preferred brand color for the interface (HEX format).

• timeFormatinteger

  Preferred time display format: 12 for AM/PM, 24 for 24-hour.

• hideBrandingboolean

  Set to true to hide Cal.com branding.

• darkBrandColorstring

  Preferred brand color for dark mode interface (HEX format).

• organizationRolestringenum

  Role of the user within the organization.

  MEMBERADMINOWNER
• defaultScheduleIdinteger

  ID of the default schedule for the new user.

Parámetros de salida

• dataobjectObligatorio

  Details of the newly created user or API response.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• activebooleanObligatorio

  Indicates if the webhook is active. If false, notifications will not be sent.

• secretstring

  Secret key for signing the webhook payload (HMAC-SHA256), enabling verification of notification authenticity.

• triggersstringObligatorioenum

  The specific event type that will trigger this webhook notification.

  BOOKING_CREATEDBOOKING_PAYMENT_INITIATEDBOOKING_PAIDBOOKING_RESCHEDULEDBOOKING_REQUESTEDBOOKING_CANCELLEDBOOKING_REJECTEDBOOKING_NO_SHOW_UPDATEDFORM_SUBMITTEDMEETING_ENDEDMEETING_STARTEDRECORDING_READY+6
• subscriberUrlstringObligatorio

  The callback URL where webhook notifications (POST requests) will be sent.

• payloadTemplatestring

  JSON string template for the webhook payload, using placeholders like {{type}} for dynamic data. Refer to Cal.com webhook documentation for available placeholders.

Parámetros de salida

• dataobjectObligatorio

  Details of the newly created webhook subscription.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• reasonstring

  An optional text explaining the reason for reassigning the booking. This can be useful for audit trails or internal communication.

• userIdintegerObligatorio

  The numerical ID of the user to whom the booking will be reassigned.

• bookingUidstringObligatorio

  The unique identifier (UID) of the booking that needs to be reassigned.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• bookingUidstringObligatorio

  Unique identifier (UID) of the booking to be reassigned.

Parámetros de salida

• dataobjectObligatorio

  Outcome of the reassignment, typically including a confirmation or status; structure may vary.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• clientIdstringObligatorio

  The unique identifier of the OAuth client application whose token is being refreshed.

• refreshTokenstringObligatorio

  The refresh token for the managed user, used to obtain a new access token; must be valid and previously issued.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the new token information, which typically includes the new access_token, token_type (e.g., 'Bearer'), expires_in (seconds), and potentially a new refresh_token.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• bookingUidstringObligatorio

  The unique identifier (UID) of the booking that needs to be rescheduled.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• bookingUidstring

  Optional unique identifier, typically used for events with seats to associate the reservation with a specific booking or seat. This can be used to retrieve details of a seated event booking.

• eventTypeIdintegerObligatorio

  The unique identifier for the event type for which the time slot is being reserved.

• slotUtcEndDatestringObligatorio

  The end date and time of the slot to be reserved, in UTC (ISO 8601 format).

• slotUtcStartDatestringObligatorio

  The start date and time of the slot to be reserved, in UTC (ISO 8601 format).

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the data returned upon successful slot reservation, which may include reservation details or confirmation.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgIdintegerObligatorio

  The unique numerical identifier of the organization.

• attributeIdstringObligatorio

  The unique string identifier of the attribute whose options are to be retrieved.

Parámetros de salida

• dataobjectObligatorio

  Retrieved attribute options. Keys and values are specific to the attribute type and configuration.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• bookingUidstringObligatorio

  Unique identifier (UID) of the booking.

Parámetros de salida

• dataobjectObligatorio

  Comprehensive details of the retrieved booking, including status, event details, attendee information, and custom fields.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• dateTostring

  The end date and time for querying busy times, preferably in ISO 8601 format (e.g., 'YYYY-MM-DDTHH:mm:ssZ' or 'YYYY-MM-DD'). If timezone is omitted, `loggedInUsersTz` is assumed. If not provided, the system may use a default end time (e.g., a certain period after the start time).

• dateFromstring

  The start date and time for querying busy times, preferably in ISO 8601 format (e.g., 'YYYY-MM-DDTHH:mm:ssZ' or 'YYYY-MM-DD'). If timezone is omitted, `loggedInUsersTz` is assumed. If not provided, the system may use a default start time (e.g., the current time).

• externalIdstringObligatorio

  The external identifier of the specific calendar to query. This should be the actual calendar ID from the provider, not the calendar type.

• credentialIdintegerObligatorio

  The numeric identifier for the credential associated with the calendar account to be queried.

• loggedInUsersTzstringObligatorio

  The IANA timezone string of the logged-in user (e.g., 'America/New_York', 'Europe/London'). This is used to correctly interpret `dateFrom` and `dateTo` if they don't contain explicit timezone information.

Parámetros de salida

• dataobjectObligatorio

  A dictionary detailing the busy time intervals. The specific keys and structure of this dictionary may vary depending on the calendar provider, but typically includes lists of start and end timestamps for busy periods.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• skipinteger

  The number of team entries to skip from the beginning of the list. Used for pagination to navigate through results.

• takeinteger

  The maximum number of team entries to return. Used for pagination to limit the size of the response.

• orgIdintegerObligatorio

  The unique identifier of the organization for which the current user's team information is being requested.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the details of the team(s) the authenticated user belongs to within the specified organization. This may include information such as team names, IDs, member roles, and other team-specific attributes.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  A dictionary of default conferencing settings. Specific keys and values (e.g., preferred video platform, default meeting duration) vary by Cal.com instance configuration.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• eventTypeIdstringObligatorio

  The unique identifier for the event type. This is typically a numerical value or a UUID string and can be found in the URL when viewing event type settings (e.g., `https://app.cal.com/event-types/<eventTypeId>`) or via other API endpoints that list event types.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the detailed information of the retrieved event type, including all its properties and settings such as name, duration, and availability.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgIdintegerObligatorio

  The unique identifier of the organization.

• membershipIdintegerObligatorio

  The unique identifier of the membership within the organization.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the detailed attributes of the membership, such as its status, role, and other relevant information.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• userIdintegerObligatorio

  The unique numerical identifier of the user.

• clientIdstringObligatorio

  The unique identifier of the OAuth client.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the detailed information of the user as it pertains to the specified OAuth client. The structure and content of this data can vary.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• clientIdstringObligatorio

  The unique identifier of the OAuth client to which the webhook belongs.

• webhookIdstringObligatorio

  The unique identifier of the webhook to retrieve.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the detailed information of the retrieved webhook, including its target URL, subscribed events, configuration, and status.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• skipinteger

  The number of attributes to skip before starting to return items. Used for pagination.

• takeinteger

  The maximum number of attributes to return. Used for pagination.

• orgIdintegerObligatorio

  The unique identifier of the organization for which attributes are to be retrieved.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgIdintegerObligatorio

  Unique identifier of the organization.

• userIdintegerObligatorio

  Unique identifier of the user.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgIdintegerObligatorio

  The unique identifier (ID) of the organization to which the webhook belongs.

• webhookIdstringObligatorio

  The unique identifier (ID) of the webhook to retrieve.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the detailed information, configuration, and current status of the retrieved webhook.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• skipinteger

  Number of webhooks to skip (for pagination). If omitted, 0 items are skipped (results start from the beginning).

• takeinteger

  Maximum webhooks to return (for pagination). If omitted, a default number of items is returned.

• orgIdintegerObligatorio

  The unique identifier of the organization for which to retrieve webhooks.

Parámetros de salida

• dataobjectObligatorio

  The API response data, typically a dictionary including a list of webhook objects (e.g., under a key like 'webhooks' or 'items') and potential pagination metadata.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• clientIdstringObligatorio

  Unique identifier of the client (provider) used to locate them in the Cal scheduling system.

Parámetros de salida

• dataobjectObligatorio

  Comprehensive details of the specified provider, which may include name, specialties, availability, and custom settings.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Contains the list of schedules. Schedule objects may include details like 'id', 'name', 'timeZone', and 'availability'.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• skipinteger

  Number of teams to skip; used for pagination.

• takeinteger

  Maximum number of teams to return; used for pagination.

• orgIdintegerObligatorio

  Unique identifier of the organization.

Parámetros de salida

• dataobjectObligatorio

  Dictionary containing the list of team details for the specified organization.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• teamIdintegerObligatorio

  The unique numerical identifier of the team for which event types are to be retrieved.

• eventSlugstring

  Optional. The unique string identifier (slug) of a specific team event type. If provided, only the event type matching this slug will be returned. If omitted, all event types for the team are returned.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the details of the retrieved team event type(s). The specific structure and content of this dictionary will vary based on the event types defined for the team, typically including properties like name, duration, and custom fields.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• orgIdintegerObligatorio

  The unique identifier for the organization to which the team belongs.

• teamIdintegerObligatorio

  The unique identifier for the team for which the membership is being retrieved.

• membershipIdintegerObligatorio

  The unique identifier for the specific membership record to be retrieved.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the detailed information of the retrieved team membership.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• teamIdintegerObligatorio

  Unique identifier of the team.

• membershipIdintegerObligatorio

  Unique identifier of the membership record.

Parámetros de salida

• dataobjectObligatorio

  Detailed attributes of the team membership, including member information, role, and status.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• skipinteger

  The number of membership records to skip before starting to return the results. Used in conjunction with 'take' for pagination.

• takeinteger

  The maximum number of membership records to return in a single response. Useful for paginating through a large list of members.

• teamIdintegerObligatorio

  The unique identifier for the team whose memberships are to be retrieved.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the API response. It typically includes a list of team memberships, detailing member roles and statuses, and may also contain pagination information.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• skipinteger

  Number of team memberships to skip; used for pagination.

• takeinteger

  Maximum number of team memberships to return; used for pagination.

• orgIdintegerObligatorio

  Unique identifier of the organization.

• teamIdintegerObligatorio

  Unique identifier of the team.

Parámetros de salida

• dataobjectObligatorio

  Contains the list of team memberships and may include pagination details.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• skipinteger

  Number of user records to skip for pagination.

• takeinteger

  Maximum number of user records to return for pagination.

• orgIdintegerObligatorio

  The unique identifier of the organization for which to retrieve users.

• emailsstring[]

  Optional list of email addresses to filter users by; only users with matching emails are returned.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the API response. This typically includes a list of user objects (each with details such as username, email, and role) belonging to the organization. May also contain pagination information or other relevant metadata.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Dictionary with conferencing details and capabilities, including installed apps and their specific settings; structure may vary by provider.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• skipinteger

  The number of webhook details to skip. Used for pagination.

• takeinteger

  The maximum number of webhook details to return. Used for pagination.

• clientIdstringObligatorio

  The unique identifier of the OAuth client for which to retrieve webhook details.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing a list of webhook objects, each providing details like subscribed events, target URLs, and status for a webhook associated with the specified OAuth client.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• skipinteger

  Number of webhook records to skip (for pagination).

• takeinteger

  Maximum number of webhook records to return (for pagination).

• eventTypeIdintegerObligatorio

  The unique identifier of the event type for which webhooks are to be retrieved.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• skipinteger

  Number of webhook records to skip before collecting results, used with 'take' for pagination to retrieve subsequent data sets.

• takeinteger

  Maximum number of webhook records to return (page size for pagination). If unspecified, a system-default limit may apply.

Parámetros de salida

• dataobjectObligatorio

  Result of the webhook retrieval, typically a dictionary containing a list of webhook objects (each with ID, URL, subscribed events, status) and potential pagination metadata.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• codestringObligatorio

  Authorization code or token required to validate and permit the save operation.

• statestringObligatorio

  Client-provided opaque string to maintain state, e.g., for CSRF protection or relaying application-specific information.

• calendarstringObligatorio

  The calendar type to save or update. Must be one of the supported calendar providers.

Parámetros de salida

• dataobjectObligatorio

  Server's response to the save operation, such as a success message or status confirmation.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• urlsstring[]Obligatorio

  A list of iCalendar (ICS) feed URLs to be imported and saved.

• readOnlyboolean

  Specifies if the imported calendar events are read-only (`True`) or writable (`False`) via the Cal API.

Parámetros de salida

• dataobjectObligatorio

  Result of the operation, confirming success or detailing issues for each URL.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• codestringObligatorio

  The authorization code received from the Google authorization server after the user has successfully authenticated and granted permissions. This code is exchanged for an access token and a refresh token.

• statestringObligatorio

  An opaque value used by the client to maintain state between the request and callback. It's also used to prevent cross-site request forgery attacks. This value is typically generated by the application initiating the OAuth flow and is returned by the Google authorization server.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the outcome of the credential saving process. Typically includes a success status or details of the saved credentials (though specific content may vary based on implementation).

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• codestringObligatorio

  The authorization code returned by Stripe after the user successfully authorizes the Cal.com application. This code is exchanged for an access token to link the Stripe account.

• statestringObligatorio

  An opaque value used to maintain state between the initial authorization request to Stripe and the callback. It's crucial for preventing cross-site request forgery (CSRF) attacks. This value should match the one sent to Stripe during the authorization redirect.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the response from the operation, typically indicating the status of saving the Stripe details and any relevant information about the connection.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• appstringObligatorio

  Identifier of a valid and configured conferencing application (e.g., 'zoom', 'google-meet') to set as the default for new meetings.

Parámetros de salida

• dataobjectObligatorio

  A dictionary containing the API response, typically confirming the operation's success or providing details of the updated default conferencing application setting.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• externalIdstringObligatorio

  The unique identifier for the calendar within the chosen service, typically obtained from the `/calendars` endpoint.

• integrationstringObligatorioenum

  The calendar service to integrate with, typically obtained from the `/calendars` endpoint.

  apple_calendargoogle_calendaroffice365_calendar

Parámetros de salida

• dataobjectObligatorio

  Result of the update operation; structure may vary.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• namestring

  New full name for the user; if provided, updates the current one.

• emailstring

  New email address for the user; if provided, updates the current one.

• localestringenum

  Preferred language and regional setting (e.g., 'en', 'es-419').

  arcadeeseuheidjalvplrosr+30
• userIdintegerObligatorio

  Identifier for the user.

• clientIdstringObligatorio

  Identifier for the OAuth client.

• timeZonestring

  Preferred IANA Time Zone Database name (e.g., 'America/New_York').

• avatarUrlstring

  URL of the user's new avatar; if provided, updates the current one.

• weekStartstringenum

  First day of the user's week.

  MondayTuesdayWednesdayThursdayFridaySaturdaySunday
• timeFormatinteger

  Preferred time format: 12 (for 12-hour clock) or 24 (for 24-hour clock).

• defaultScheduleIdinteger

  ID of the user's default schedule, applied when no event-specific schedule is chosen.

Parámetros de salida

• dataobjectObligatorio

  Dictionary containing the user's updated settings, reflecting the Cal.com user model.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not