> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # cal-teams > Cal.com Teams - manage teams, team event types, and memberships **Server path:** `/cal-teams` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | --------------------------------------------------------------------------------------------------------------------- | ------------------------ | | [`cal_teams_controller_create_team`](#cal_teams_controller_create_team) | Create a team | | [`cal_teams_controller_delete_team`](#cal_teams_controller_delete_team) | Delete a team | | [`cal_teams_controller_get_team`](#cal_teams_controller_get_team) | Get a team | | [`cal_teams_controller_get_teams`](#cal_teams_controller_get_teams) | Get teams | | [`cal_teams_controller_update_team`](#cal_teams_controller_update_team) | Update a team | | [`cal_teams_event_types_controller_create_phone_call`](#cal_teams_event_types_controller_create_phone_call) | Create a phone call | | [`cal_teams_event_types_controller_create_team_event_type`](#cal_teams_event_types_controller_create_team_event_type) | Create an event type | | [`cal_teams_event_types_controller_delete_team_event_type`](#cal_teams_event_types_controller_delete_team_event_type) | Delete a team event type | | [`cal_teams_event_types_controller_get_team_event_type`](#cal_teams_event_types_controller_get_team_event_type) | Get an event type | | [`cal_teams_event_types_controller_get_team_event_types`](#cal_teams_event_types_controller_get_team_event_types) | Get team event types | | [`cal_teams_event_types_controller_update_team_event_type`](#cal_teams_event_types_controller_update_team_event_type) | Update a team event type | | [`cal_teams_memberships_controller_create_team_membership`](#cal_teams_memberships_controller_create_team_membership) | Create a membership | | [`cal_teams_memberships_controller_delete_team_membership`](#cal_teams_memberships_controller_delete_team_membership) | Delete a membership | | [`cal_teams_memberships_controller_get_team_membership`](#cal_teams_memberships_controller_get_team_membership) | Get a membership | | [`cal_teams_memberships_controller_get_team_memberships`](#cal_teams_memberships_controller_get_team_memberships) | Get all memberships | | [`cal_teams_memberships_controller_update_team_membership`](#cal_teams_memberships_controller_update_team_membership) | Update membership | *** ## cal\_teams\_controller\_create\_team Create a team **Parameters:** | Parameter | Type | Required | Default | Description | | --------------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `appIconLogo` | string | No | — | App Icon Logo | | `appLogo` | string | No | — | App Logo | | `autoAcceptCreator` | boolean | No | — | If you are a platform customer, don't pass 'false', because then team creator won't be able to create team event types. | | `bannerUrl` | string | No | — | URL of the teams banner image which is shown on booker | | `bio` | string | No | — | The bio value | | `brandColor` | string | No | — | Brand Color | | `calVideoLogo` | string | No | — | Cal Video Logo | | `darkBrandColor` | string | No | — | Dark Brand Color | | `hideBookATeamMember` | boolean | No | — | Hide Book A Team Member | | `hideBranding` | boolean | No | — | Hide Branding | | `isPrivate` | boolean | No | — | Is Private | | `logoUrl` | string | No | — | URL of the teams logo image | | `metadata` | object | No | — | You can store any additional data you want here. Metadata must have at most 50 keys, each key up to 40 characters. Values can be strings (up to 500 characters), numbers, or booleans. | | `name` | string | Yes | — | Name of the team | | `slug` | string | No | — | Team slug in kebab-case - if not provided will be generated automatically based on name. | | `theme` | string | No | — | The theme value | | `timeFormat` | number | No | — | Time Format | | `timeZone` | string | No | — | Timezone is used to create teams's default schedule from Monday to Friday from 9AM to 5PM. It will default to Europe/London if not passed. | | `weekStart` | string | No | — | Week Start | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "appIconLogo": { "type": "string", "description": "App Icon Logo" }, "appLogo": { "type": "string", "description": "App Logo" }, "autoAcceptCreator": { "type": "boolean", "description": "If you are a platform customer, don't pass 'false', because then team creator won't be able to create team event types." }, "bannerUrl": { "type": "string", "description": "URL of the teams banner image which is shown on booker" }, "bio": { "type": "string", "description": "The bio value" }, "brandColor": { "type": "string", "description": "Brand Color" }, "calVideoLogo": { "type": "string", "description": "Cal Video Logo" }, "darkBrandColor": { "type": "string", "description": "Dark Brand Color" }, "hideBookATeamMember": { "type": "boolean", "description": "Hide Book A Team Member" }, "hideBranding": { "type": "boolean", "description": "Hide Branding" }, "isPrivate": { "type": "boolean", "description": "Is Private" }, "logoUrl": { "type": "string", "description": "URL of the teams logo image" }, "metadata": { "type": "object", "description": "You can store any additional data you want here. Metadata must have at most 50 keys, each key up to 40 characters. Values can be strings (up to 500 characters), numbers, or booleans." }, "name": { "type": "string", "description": "Name of the team" }, "slug": { "type": "string", "description": "Team slug in kebab-case - if not provided will be generated automatically based on name." }, "theme": { "type": "string", "description": "The theme value" }, "timeFormat": { "type": "number", "description": "Time Format" }, "timeZone": { "type": "string", "description": "Timezone is used to create teams's default schedule from Monday to Friday from 9AM to 5PM. It will default to Europe/London if not passed." }, "weekStart": { "type": "string", "description": "Week Start" } }, "required": [ "PCID", "name" ] } ``` *** ## cal\_teams\_controller\_delete\_team Delete a team **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------- | | `teamId` | number | Yes | — | Team Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "teamId": { "type": "number", "description": "Team Id" } }, "required": [ "PCID", "teamId" ] } ``` *** ## cal\_teams\_controller\_get\_team Get a team **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ----------- | | `teamId` | number | Yes | — | Team Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "teamId": { "type": "number", "description": "Team Id" } }, "required": [ "PCID", "teamId" ] } ``` *** ## cal\_teams\_controller\_get\_teams Get teams ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## cal\_teams\_controller\_update\_team Update a team **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------------ | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `teamId` | number | Yes | — | Team Id | | `appIconLogo` | string | No | — | App Icon Logo | | `appLogo` | string | No | — | App Logo | | `bannerUrl` | string | No | — | URL of the teams banner image which is shown on booker | | `bio` | string | No | — | The bio value | | `bookingLimits` | string | No | — | Booking Limits | | `brandColor` | string | No | — | Brand Color | | `calVideoLogo` | string | No | — | Cal Video Logo | | `darkBrandColor` | string | No | — | Dark Brand Color | | `hideBookATeamMember` | boolean | No | — | Hide Book A Team Member | | `hideBranding` | boolean | No | — | Hide Branding | | `includeManagedEventsInLimits` | boolean | No | — | Include Managed Events In Limits | | `isPrivate` | boolean | No | — | Is Private | | `logoUrl` | string | No | — | URL of the teams logo image | | `metadata` | object | No | — | You can store any additional data you want here. Metadata must have at most 50 keys, each key up to 40 characters. Values can be strings (up to 500 characters), numbers, or booleans. | | `name` | string | No | — | Name of the team | | `slug` | string | No | — | Team slug | | `theme` | string | No | — | The theme value | | `timeFormat` | number | No | — | Time Format | | `timeZone` | string | No | — | Timezone is used to create teams's default schedule from Monday to Friday from 9AM to 5PM. It will default to Europe/London if not passed. | | `weekStart` | string | No | — | Week Start | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "teamId": { "type": "number", "description": "Team Id" }, "appIconLogo": { "type": "string", "description": "App Icon Logo" }, "appLogo": { "type": "string", "description": "App Logo" }, "bannerUrl": { "type": "string", "description": "URL of the teams banner image which is shown on booker" }, "bio": { "type": "string", "description": "The bio value" }, "bookingLimits": { "type": "string", "description": "Booking Limits" }, "brandColor": { "type": "string", "description": "Brand Color" }, "calVideoLogo": { "type": "string", "description": "Cal Video Logo" }, "darkBrandColor": { "type": "string", "description": "Dark Brand Color" }, "hideBookATeamMember": { "type": "boolean", "description": "Hide Book A Team Member" }, "hideBranding": { "type": "boolean", "description": "Hide Branding" }, "includeManagedEventsInLimits": { "type": "boolean", "description": "Include Managed Events In Limits" }, "isPrivate": { "type": "boolean", "description": "Is Private" }, "logoUrl": { "type": "string", "description": "URL of the teams logo image" }, "metadata": { "type": "object", "description": "You can store any additional data you want here. Metadata must have at most 50 keys, each key up to 40 characters. Values can be strings (up to 500 characters), numbers, or booleans." }, "name": { "type": "string", "description": "Name of the team" }, "slug": { "type": "string", "description": "Team slug" }, "theme": { "type": "string", "description": "The theme value" }, "timeFormat": { "type": "number", "description": "Time Format" }, "timeZone": { "type": "string", "description": "Timezone is used to create teams's default schedule from Monday to Friday from 9AM to 5PM. It will default to Europe/London if not passed." }, "weekStart": { "type": "string", "description": "Week Start" } }, "required": [ "PCID", "teamId" ] } ``` *** ## cal\_teams\_event\_types\_controller\_create\_phone\_call Create a phone call **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | ----------------- | | `eventTypeId` | number | Yes | — | Event Type Id | | `orgId` | number | Yes | — | Org Id | | `teamId` | number | Yes | — | Team Id | | `beginMessage` | string | No | — | Begin message | | `calApiKey` | string | Yes | — | CAL API Key | | `enabled` | boolean | Yes | — | Enabled status | | `generalPrompt` | string | No | — | General prompt | | `guestCompany` | string | No | — | Guest company | | `guestEmail` | string | No | — | Guest email | | `guestName` | string | No | — | Guest name | | `numberToCall` | string | Yes | — | Number to call | | `schedulerName` | string | No | — | Scheduler name | | `templateType` | string | Yes | — | Template type | | `yourPhoneNumber` | string | Yes | — | Your phone number | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "eventTypeId": { "type": "number", "description": "Event Type Id" }, "orgId": { "type": "number", "description": "Org Id" }, "teamId": { "type": "number", "description": "Team Id" }, "beginMessage": { "type": "string", "description": "Begin message" }, "calApiKey": { "type": "string", "description": "CAL API Key" }, "enabled": { "type": "boolean", "description": "Enabled status" }, "generalPrompt": { "type": "string", "description": "General prompt" }, "guestCompany": { "type": "string", "description": "Guest company" }, "guestEmail": { "type": "string", "description": "Guest email" }, "guestName": { "type": "string", "description": "Guest name" }, "numberToCall": { "type": "string", "description": "Number to call" }, "schedulerName": { "type": "string", "description": "Scheduler name" }, "templateType": { "type": "string", "description": "Template type", "enum": [ "CHECK_IN_APPOINTMENT", "CUSTOM_TEMPLATE" ] }, "yourPhoneNumber": { "type": "string", "description": "Your phone number" } }, "required": [ "PCID", "eventTypeId", "orgId", "teamId", "calApiKey", "enabled", "numberToCall", "templateType", "yourPhoneNumber" ] } ``` *** ## cal\_teams\_event\_types\_controller\_create\_team\_event\_type Create an event type **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------------------ | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `teamId` | number | Yes | — | Team Id | | `afterEventBuffer` | number | No | — | Extra time automatically blocked on your calendar after a meeting ends. This gives you time to wrap up, add notes, or decompress before your next commitment. | | `allowReschedulingCancelledBookings` | boolean | No | — | When enabled, users will be able to create a new booking when trying to reschedule a cancelled booking. | | `allowReschedulingPastBookings` | boolean | No | — | Enabling this option allows for past events to be rescheduled. | | `assignAllTeamMembers` | boolean | No | — | If true, all current and future team members will be assigned to this event type. Provide either assignAllTeamMembers or hosts but not both | | `beforeEventBuffer` | number | No | — | Extra time automatically blocked on your calendar before a meeting starts. This gives you time to prepare, review notes, or transition from your previous activity. | | `bookerActiveBookingsLimit` | object | No | — | Limit the number of active bookings a booker can make for this event type. | | `bookerLayouts` | object | No | — | Should booker have week, month or column view. Specify default layout and enabled layouts user can pick. | | `bookingFields` | any\[] | No | — | Custom fields that can be added to the booking form when the event is booked by someone. By default booking form has name and email field. | | `bookingLimitsCount` | object | No | — | Limit how many times this event can be booked | | `bookingLimitsDuration` | object | No | — | Limit total amount of time that this event can be booked | | `bookingRequiresAuthentication` | boolean | No | — | Boolean to require authentication for booking this event type via api. If true, only authenticated users who are the event-type owner or org/team admin/owner can book this event type. | | `bookingWindow` | object | No | — | Limit how far in the future this event can be booked | | `calVideoSettings` | object | No | — | Cal video settings for the event type. Platform customers can't manage this property because currently we have no way of determining if managed user is a host or an attendee. | | `color` | object | No | — | The color value | | `confirmationPolicy` | object | No | — | Specify how the booking needs to be manually confirmed before it is pushed to the integrations and a confirmation mail is sent. | | `customName` | string | No | — | Customizable event name with valid variables: \{Event type title}, \{Organiser}, \{Scheduler}, \{Location}, \{Organiser first name}, \{Scheduler first name}, \{Scheduler last name}, \{Event duration}, \{LOCATION}, \{HOST/ATTENDEE}, \{HOST}, \{ATTENDEE}, \{USER} | | `description` | string | No | — | The description value | | `destinationCalendar` | object | No | — | Destination Calendar | | `disableCancelling` | object | No | — | Settings for disabling cancelling of this event type. | | `disableGuests` | boolean | No | — | If true, person booking this event can't add guests via their emails. | | `disableRescheduling` | object | No | — | Settings for disabling rescheduling of this event type. Can be always disabled or disabled when less than X minutes before the meeting. | | `emailSettings` | object | No | — | Email settings for this event type - only available for organization team event types. | | `hidden` | boolean | No | — | The hidden value | | `hideCalendarEventDetails` | boolean | No | — | Hide Calendar Event Details | | `hideCalendarNotes` | boolean | No | — | Hide Calendar Notes | | `hideOrganizerEmail` | boolean | No | — | Boolean to Hide organizer's email address from the booking screen, email notifications, and calendar events | | `hosts` | object\[] | No | — | Hosts contain specific team members you want to assign to this event type, but if you want to assign all team members, use `assignAllTeamMembers: true` instead and omit this field. For platform customers the hosts can include userIds only of managed users. Provide either hosts or assignAllTeamMembers but not both | | `interfaceLanguage` | string | No | — | Set preferred language for the booking interface. Use empty string for visitor's browser language (default). | | `lengthInMinutes` | number | Yes | — | Length In Minutes | | `lengthInMinutesOptions` | string\[] | No | — | If you want that user can choose between different lengths of the event you can specify them here. Must include the provided `lengthInMinutes`. | | `locations` | any\[] | No | — | Locations where the event will take place. If not provided, cal video link will be used as the location. Note: Setting a location to a conferencing app does not install the app - the app must already be installed. Via API, only Google Meet (google-meet), Microsoft Teams (office365-video), and Zoom (zoom) can be installed. Cal Video (cal-video) is installed by default. All other conferencing apps must be connected via the Cal.com web app and are not available for Platform plan customers. You can only set an event type location to an app that has already been installed or connected. | | `lockTimeZoneToggleOnBookingPage` | boolean | No | — | Lock Time Zone Toggle On Booking Page | | `minimumBookingNotice` | number | No | — | Minimum number of minutes before the event that a booking can be made. | | `offsetStart` | number | No | — | Offset timeslots shown to bookers by a specified number of minutes | | `onlyShowFirstAvailableSlot` | boolean | No | — | This will limit your availability for this event type to one slot per day, scheduled at the earliest available time. | | `recurrence` | object | No | — | Create a recurring event type. | | `requiresBookerEmailVerification` | boolean | No | — | Requires Booker Email Verification | | `rescheduleWithSameRoundRobinHost` | boolean | No | — | Rescheduled events will be assigned to the same host as initially scheduled. | | `scheduleId` | number | No | — | If you want that this event has different schedule than user's default one you can specify it here. | | `schedulingType` | string | Yes | — | The scheduling type for the team event - collective, roundRobin or managed. | | `seats` | object | No | — | Create an event type with multiple seats. | | `showOptimizedSlots` | boolean | No | — | Arrange time slots to optimize availability. | | `slotInterval` | number | No | — | Number representing length of each slot when event is booked. By default it equal length of the event type. If event length is 60 minutes then we would have slots 9AM, 10AM, 11AM etc. but if it was changed to 30 minutes then we would have slots 9AM, 9:30AM, 10AM, 10:30AM etc. as the available times to book the 60 minute event. | | `slug` | string | Yes | — | The slug value | | `successRedirectUrl` | string | No | — | A valid URL where the booker will redirect to, once the booking is completed successfully | | `title` | string | Yes | — | The title value | | `useDestinationCalendarEmail` | boolean | No | — | Use Destination Calendar Email | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "teamId": { "type": "number", "description": "Team Id" }, "afterEventBuffer": { "type": "number", "description": "Extra time automatically blocked on your calendar after a meeting ends. This gives you time to wrap up, add notes, or decompress before your next commitment." }, "allowReschedulingCancelledBookings": { "type": "boolean", "description": "When enabled, users will be able to create a new booking when trying to reschedule a cancelled booking." }, "allowReschedulingPastBookings": { "type": "boolean", "description": "Enabling this option allows for past events to be rescheduled." }, "assignAllTeamMembers": { "type": "boolean", "description": "If true, all current and future team members will be assigned to this event type. Provide either assignAllTeamMembers or hosts but not both" }, "beforeEventBuffer": { "type": "number", "description": "Extra time automatically blocked on your calendar before a meeting starts. This gives you time to prepare, review notes, or transition from your previous activity." }, "bookerActiveBookingsLimit": { "description": "Limit the number of active bookings a booker can make for this event type." }, "bookerLayouts": { "description": "Should booker have week, month or column view. Specify default layout and enabled layouts user can pick." }, "bookingFields": { "type": "array", "description": "Custom fields that can be added to the booking form when the event is booked by someone. By default booking form has name and email field." }, "bookingLimitsCount": { "description": "Limit how many times this event can be booked" }, "bookingLimitsDuration": { "description": "Limit total amount of time that this event can be booked" }, "bookingRequiresAuthentication": { "type": "boolean", "description": "Boolean to require authentication for booking this event type via api. If true, only authenticated users who are the event-type owner or org/team admin/owner can book this event type." }, "bookingWindow": { "description": "Limit how far in the future this event can be booked" }, "calVideoSettings": { "description": "Cal video settings for the event type. Platform customers can't manage this property because currently we have no way of determining if managed user is a host or an attendee." }, "color": { "type": "object", "description": "The color value", "properties": { "lightThemeHex": { "type": "string", "description": "Color used for event types in light theme" }, "darkThemeHex": { "type": "string", "description": "Color used for event types in dark theme" } }, "required": [ "lightThemeHex", "darkThemeHex" ] }, "confirmationPolicy": { "description": "Specify how the booking needs to be manually confirmed before it is pushed to the integrations and a confirmation mail is sent." }, "customName": { "type": "string", "description": "Customizable event name with valid variables: {Event type title}, {Organiser}, {Scheduler}, {Location}, {Organiser first name}, {Scheduler first name}, {Scheduler last name}, {Event duration}, {LOCATION}, {HOST/ATTENDEE}, {HOST}, {ATTENDEE}, {USER}" }, "description": { "type": "string", "description": "The description value" }, "destinationCalendar": { "type": "object", "description": "Destination Calendar", "properties": { "integration": { "type": "string", "description": "The integration type of the destination calendar. Refer to the /api/v2/calendars endpoint to retrieve the integration type of your connected calendars." }, "externalId": { "type": "string", "description": "The external ID of the destination calendar. Refer to the /api/v2/calendars endpoint to retrieve the external IDs of your connected calendars." } }, "required": [ "integration", "externalId" ] }, "disableCancelling": { "description": "Settings for disabling cancelling of this event type." }, "disableGuests": { "type": "boolean", "description": "If true, person booking this event can't add guests via their emails." }, "disableRescheduling": { "description": "Settings for disabling rescheduling of this event type. Can be always disabled or disabled when less than X minutes before the meeting." }, "emailSettings": { "description": "Email settings for this event type - only available for organization team event types." }, "hidden": { "type": "boolean", "description": "The hidden value" }, "hideCalendarEventDetails": { "type": "boolean", "description": "Hide Calendar Event Details" }, "hideCalendarNotes": { "type": "boolean", "description": "Hide Calendar Notes" }, "hideOrganizerEmail": { "type": "boolean", "description": "Boolean to Hide organizer's email address from the booking screen, email notifications, and calendar events" }, "hosts": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "number", "description": "Which user is the host of this event" }, "mandatory": { "type": "boolean", "description": "Only relevant for round robin event types. If true then the user must attend round robin event always." }, "priority": { "type": "string", "enum": [ "lowest", "low", "medium", "high", "highest" ], "description": "The priority value" } }, "required": [ "userId" ] }, "description": "Hosts contain specific team members you want to assign to this event type, but if you want to assign all team members, use `assignAllTeamMembers: true` instead and omit this field. For platform customers the hosts can include userIds only of managed users. Provide either hosts or assignAllTeamMembers but not both" }, "interfaceLanguage": { "type": "string", "description": "Set preferred language for the booking interface. Use empty string for visitor's browser language (default).", "enum": [ "", "en", "ar", "az", "bg", "bn", "ca", "cs", "da", "de", "el", "es", "es-419", "eu", "et", "fi", "fr", "he", "hu", "it", "ja", "km", "ko", "nl", "no", "pl", "pt-BR", "pt", "ro", "ru", "sk-SK", "sr", "sv", "tr", "uk", "vi", "zh-CN", "zh-TW" ] }, "lengthInMinutes": { "type": "number", "description": "Length In Minutes" }, "lengthInMinutesOptions": { "type": "array", "items": { "type": "string" }, "description": "If you want that user can choose between different lengths of the event you can specify them here. Must include the provided `lengthInMinutes`." }, "locations": { "type": "array", "description": "Locations where the event will take place. If not provided, cal video link will be used as the location. Note: Setting a location to a conferencing app does not install the app - the app must already be installed. Via API, only Google Meet (google-meet), Microsoft Teams (office365-video), and Zoom (zoom) can be installed. Cal Video (cal-video) is installed by default. All other conferencing apps must be connected via the Cal.com web app and are not available for Platform plan customers. You can only set an event type location to an app that has already been installed or connected." }, "lockTimeZoneToggleOnBookingPage": { "type": "boolean", "description": "Lock Time Zone Toggle On Booking Page" }, "minimumBookingNotice": { "type": "number", "description": "Minimum number of minutes before the event that a booking can be made." }, "offsetStart": { "type": "number", "description": "Offset timeslots shown to bookers by a specified number of minutes" }, "onlyShowFirstAvailableSlot": { "type": "boolean", "description": "This will limit your availability for this event type to one slot per day, scheduled at the earliest available time." }, "recurrence": { "description": "Create a recurring event type." }, "requiresBookerEmailVerification": { "type": "boolean", "description": "Requires Booker Email Verification" }, "rescheduleWithSameRoundRobinHost": { "type": "boolean", "description": "Rescheduled events will be assigned to the same host as initially scheduled." }, "scheduleId": { "type": "number", "description": "If you want that this event has different schedule than user's default one you can specify it here." }, "schedulingType": { "type": "string", "description": "The scheduling type for the team event - collective, roundRobin or managed.", "enum": [ "collective", "roundRobin", "managed" ] }, "seats": { "description": "Create an event type with multiple seats." }, "showOptimizedSlots": { "type": "boolean", "description": "Arrange time slots to optimize availability." }, "slotInterval": { "type": "number", "description": "Number representing length of each slot when event is booked. By default it equal length of the event type. If event length is 60 minutes then we would have slots 9AM, 10AM, 11AM etc. but if it was changed to 30 minutes then we would have slots 9AM, 9:30AM, 10AM, 10:30AM etc. as the available times to book the 60 minute event." }, "slug": { "type": "string", "description": "The slug value" }, "successRedirectUrl": { "type": "string", "description": "A valid URL where the booker will redirect to, once the booking is completed successfully" }, "title": { "type": "string", "description": "The title value" }, "useDestinationCalendarEmail": { "type": "boolean", "description": "Use Destination Calendar Email" } }, "required": [ "PCID", "teamId", "lengthInMinutes", "schedulingType", "slug", "title" ] } ``` *** ## cal\_teams\_event\_types\_controller\_delete\_team\_event\_type Delete a team event type **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | ------------- | | `teamId` | number | Yes | — | Team Id | | `eventTypeId` | number | Yes | — | Event Type Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "teamId": { "type": "number", "description": "Team Id" }, "eventTypeId": { "type": "number", "description": "Event Type Id" } }, "required": [ "PCID", "teamId", "eventTypeId" ] } ``` *** ## cal\_teams\_event\_types\_controller\_get\_team\_event\_type Get an event type **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------ | -------- | ------- | ------------- | | `teamId` | number | Yes | — | Team Id | | `eventTypeId` | number | Yes | — | Event Type Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "teamId": { "type": "number", "description": "Team Id" }, "eventTypeId": { "type": "number", "description": "Event Type Id" } }, "required": [ "PCID", "teamId", "eventTypeId" ] } ``` *** ## cal\_teams\_event\_types\_controller\_get\_team\_event\_types Get team event types **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | `teamId` | number | Yes | — | Team Id | | `eventSlug` | string | No | — | Slug of team event type to return. | | `hostsLimit` | number | No | — | Specifies the maximum number of hosts to include in the response. This limit helps optimize performance. If not provided, all Hosts will be fetched. | | `sortCreatedAt` | string | No | — | Sort event types by creation date. When not provided, no explicit ordering is applied. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "teamId": { "type": "number", "description": "Team Id" }, "eventSlug": { "type": "string", "description": "Slug of team event type to return." }, "hostsLimit": { "type": "number", "description": "Specifies the maximum number of hosts to include in the response. This limit helps optimize performance. If not provided, all Hosts will be fetched." }, "sortCreatedAt": { "type": "string", "description": "Sort event types by creation date. When not provided, no explicit ordering is applied.", "enum": [ "asc", "desc" ] } }, "required": [ "PCID", "teamId" ] } ``` *** ## cal\_teams\_event\_types\_controller\_update\_team\_event\_type Update a team event type **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------------------------ | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `teamId` | number | Yes | — | Team Id | | `eventTypeId` | number | Yes | — | Event Type Id | | `afterEventBuffer` | number | No | — | Extra time automatically blocked on your calendar after a meeting ends. This gives you time to wrap up, add notes, or decompress before your next commitment. | | `allowReschedulingCancelledBookings` | boolean | No | — | When enabled, users will be able to create a new booking when trying to reschedule a cancelled booking. | | `allowReschedulingPastBookings` | boolean | No | — | Enabling this option allows for past events to be rescheduled. | | `assignAllTeamMembers` | boolean | No | — | If true, all current and future team members will be assigned to this event type. Provide either assignAllTeamMembers or hosts but not both | | `beforeEventBuffer` | number | No | — | Extra time automatically blocked on your calendar before a meeting starts. This gives you time to prepare, review notes, or transition from your previous activity. | | `bookerActiveBookingsLimit` | object | No | — | Limit the number of active bookings a booker can make for this event type. | | `bookerLayouts` | object | No | — | Should booker have week, month or column view. Specify default layout and enabled layouts user can pick. | | `bookingFields` | any\[] | No | — | Complete set of booking form fields. This array replaces all existing booking fields. To modify existing fields, first fetch the current event type, then include all desired fields in this array. Sending only one field will remove all other custom fields, keeping only default fields plus the provided one. | | `bookingLimitsCount` | object | No | — | Limit how many times this event can be booked | | `bookingLimitsDuration` | object | No | — | Limit total amount of time that this event can be booked | | `bookingRequiresAuthentication` | boolean | No | — | Boolean to require authentication for booking this event type via api. If true, only authenticated users who are the event-type owner or org/team admin/owner can book this event type. | | `bookingWindow` | object | No | — | Limit how far in the future this event can be booked | | `calVideoSettings` | object | No | — | Cal video settings for the event type | | `color` | object | No | — | The color value | | `confirmationPolicy` | object | No | — | Specify how the booking needs to be manually confirmed before it is pushed to the integrations and a confirmation mail is sent. | | `customName` | string | No | — | Customizable event name with valid variables: \{Event type title}, \{Organiser}, \{Scheduler}, \{Location}, \{Organiser first name}, \{Scheduler first name}, \{Scheduler last name}, \{Event duration}, \{LOCATION}, \{HOST/ATTENDEE}, \{HOST}, \{ATTENDEE}, \{USER} | | `description` | string | No | — | The description value | | `destinationCalendar` | object | No | — | Destination Calendar | | `disableCancelling` | object | No | — | Settings for disabling cancelling of this event type. | | `disableGuests` | boolean | No | — | If true, person booking this event can't add guests via their emails. | | `disableRescheduling` | object | No | — | Settings for disabling rescheduling of this event type. Can be always disabled or disabled when less than X minutes before the meeting. | | `emailSettings` | object | No | — | Email settings for this event type. Only available for organization team event types. | | `hidden` | boolean | No | — | The hidden value | | `hideCalendarEventDetails` | boolean | No | — | Hide Calendar Event Details | | `hideCalendarNotes` | boolean | No | — | Hide Calendar Notes | | `hideOrganizerEmail` | boolean | No | — | Boolean to Hide organizer's email address from the booking screen, email notifications, and calendar events | | `hosts` | object\[] | No | — | Hosts contain specific team members you want to assign to this event type, but if you want to assign all team members, use `assignAllTeamMembers: true` instead and omit this field. For platform customers the hosts can include userIds only of managed users. Provide either hosts or assignAllTeamMembers but not both | | `interfaceLanguage` | string | No | — | Set preferred language for the booking interface. Use empty string for visitor's browser language (default). | | `lengthInMinutes` | number | No | — | Length In Minutes | | `lengthInMinutesOptions` | string\[] | No | — | If you want that user can choose between different lengths of the event you can specify them here. Must include the provided `lengthInMinutes`. | | `locations` | any\[] | No | — | Locations where the event will take place. If not provided, cal video link will be used as the location. Note: Setting a location to a conferencing app does not install the app - the app must already be installed. Via API, only Google Meet (google-meet), Microsoft Teams (office365-video), and Zoom (zoom) can be installed. Cal Video (cal-video) is installed by default. All other conferencing apps must be connected via the Cal.com web app and are not available for Platform plan customers. You can only set an event type location to an app that has already been installed or connected. | | `lockTimeZoneToggleOnBookingPage` | boolean | No | — | Lock Time Zone Toggle On Booking Page | | `minimumBookingNotice` | number | No | — | Minimum number of minutes before the event that a booking can be made. | | `offsetStart` | number | No | — | Offset timeslots shown to bookers by a specified number of minutes | | `onlyShowFirstAvailableSlot` | boolean | No | — | This will limit your availability for this event type to one slot per day, scheduled at the earliest available time. | | `recurrence` | object | No | — | Create a recurring event type. | | `requiresBookerEmailVerification` | boolean | No | — | Requires Booker Email Verification | | `rescheduleWithSameRoundRobinHost` | boolean | No | — | Rescheduled events will be assigned to the same host as initially scheduled. | | `scheduleId` | number | No | — | If you want that this event has different schedule than user's default one you can specify it here. | | `schedulingType` | string | No | — | The scheduling type for the team event - collective or roundRobin. ❗If you change scheduling type you must also provide `hosts` or `assignAllTeamMembers` in the request body, otherwise the event type will have no hosts - this is required because in case of collective event type all hosts are mandatory but in case of round robin some or non can be mandatory so we can't predict how you want the hosts to be setup which is why you must provide that information. If you want to convert round robin or collective into managed or managed into round robin or collective then you will have to create a new team event type and delete old one. | | `seats` | object | No | — | Create an event type with multiple seats. | | `showOptimizedSlots` | boolean | No | — | Arrange time slots to optimize availability. | | `slotInterval` | number | No | — | Number representing length of each slot when event is booked. By default it equal length of the event type. If event length is 60 minutes then we would have slots 9AM, 10AM, 11AM etc. but if it was changed to 30 minutes then we would have slots 9AM, 9:30AM, 10AM, 10:30AM etc. as the available times to book the 60 minute event. | | `slug` | string | No | — | The slug value | | `successRedirectUrl` | string | No | — | A valid URL where the booker will redirect to, once the booking is completed successfully | | `title` | string | No | — | The title value | | `useDestinationCalendarEmail` | boolean | No | — | Use Destination Calendar Email | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "teamId": { "type": "number", "description": "Team Id" }, "eventTypeId": { "type": "number", "description": "Event Type Id" }, "afterEventBuffer": { "type": "number", "description": "Extra time automatically blocked on your calendar after a meeting ends. This gives you time to wrap up, add notes, or decompress before your next commitment." }, "allowReschedulingCancelledBookings": { "type": "boolean", "description": "When enabled, users will be able to create a new booking when trying to reschedule a cancelled booking." }, "allowReschedulingPastBookings": { "type": "boolean", "description": "Enabling this option allows for past events to be rescheduled." }, "assignAllTeamMembers": { "type": "boolean", "description": "If true, all current and future team members will be assigned to this event type. Provide either assignAllTeamMembers or hosts but not both" }, "beforeEventBuffer": { "type": "number", "description": "Extra time automatically blocked on your calendar before a meeting starts. This gives you time to prepare, review notes, or transition from your previous activity." }, "bookerActiveBookingsLimit": { "description": "Limit the number of active bookings a booker can make for this event type." }, "bookerLayouts": { "description": "Should booker have week, month or column view. Specify default layout and enabled layouts user can pick." }, "bookingFields": { "type": "array", "description": "Complete set of booking form fields. This array replaces all existing booking fields. To modify existing fields, first fetch the current event type, then include all desired fields in this array. Sending only one field will remove all other custom fields, keeping only default fields plus the provided one." }, "bookingLimitsCount": { "description": "Limit how many times this event can be booked" }, "bookingLimitsDuration": { "description": "Limit total amount of time that this event can be booked" }, "bookingRequiresAuthentication": { "type": "boolean", "description": "Boolean to require authentication for booking this event type via api. If true, only authenticated users who are the event-type owner or org/team admin/owner can book this event type." }, "bookingWindow": { "description": "Limit how far in the future this event can be booked" }, "calVideoSettings": { "description": "Cal video settings for the event type" }, "color": { "type": "object", "description": "The color value", "properties": { "lightThemeHex": { "type": "string", "description": "Color used for event types in light theme" }, "darkThemeHex": { "type": "string", "description": "Color used for event types in dark theme" } }, "required": [ "lightThemeHex", "darkThemeHex" ] }, "confirmationPolicy": { "description": "Specify how the booking needs to be manually confirmed before it is pushed to the integrations and a confirmation mail is sent." }, "customName": { "type": "string", "description": "Customizable event name with valid variables: {Event type title}, {Organiser}, {Scheduler}, {Location}, {Organiser first name}, {Scheduler first name}, {Scheduler last name}, {Event duration}, {LOCATION}, {HOST/ATTENDEE}, {HOST}, {ATTENDEE}, {USER}" }, "description": { "type": "string", "description": "The description value" }, "destinationCalendar": { "type": "object", "description": "Destination Calendar", "properties": { "integration": { "type": "string", "description": "The integration type of the destination calendar. Refer to the /api/v2/calendars endpoint to retrieve the integration type of your connected calendars." }, "externalId": { "type": "string", "description": "The external ID of the destination calendar. Refer to the /api/v2/calendars endpoint to retrieve the external IDs of your connected calendars." } }, "required": [ "integration", "externalId" ] }, "disableCancelling": { "description": "Settings for disabling cancelling of this event type." }, "disableGuests": { "type": "boolean", "description": "If true, person booking this event can't add guests via their emails." }, "disableRescheduling": { "description": "Settings for disabling rescheduling of this event type. Can be always disabled or disabled when less than X minutes before the meeting." }, "emailSettings": { "description": "Email settings for this event type. Only available for organization team event types." }, "hidden": { "type": "boolean", "description": "The hidden value" }, "hideCalendarEventDetails": { "type": "boolean", "description": "Hide Calendar Event Details" }, "hideCalendarNotes": { "type": "boolean", "description": "Hide Calendar Notes" }, "hideOrganizerEmail": { "type": "boolean", "description": "Boolean to Hide organizer's email address from the booking screen, email notifications, and calendar events" }, "hosts": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "number", "description": "Which user is the host of this event" }, "mandatory": { "type": "boolean", "description": "Only relevant for round robin event types. If true then the user must attend round robin event always." }, "priority": { "type": "string", "enum": [ "lowest", "low", "medium", "high", "highest" ], "description": "The priority value" } }, "required": [ "userId" ] }, "description": "Hosts contain specific team members you want to assign to this event type, but if you want to assign all team members, use `assignAllTeamMembers: true` instead and omit this field. For platform customers the hosts can include userIds only of managed users. Provide either hosts or assignAllTeamMembers but not both" }, "interfaceLanguage": { "type": "string", "description": "Set preferred language for the booking interface. Use empty string for visitor's browser language (default).", "enum": [ "", "en", "ar", "az", "bg", "bn", "ca", "cs", "da", "de", "el", "es", "es-419", "eu", "et", "fi", "fr", "he", "hu", "it", "ja", "km", "ko", "nl", "no", "pl", "pt-BR", "pt", "ro", "ru", "sk-SK", "sr", "sv", "tr", "uk", "vi", "zh-CN", "zh-TW" ] }, "lengthInMinutes": { "type": "number", "description": "Length In Minutes" }, "lengthInMinutesOptions": { "type": "array", "items": { "type": "string" }, "description": "If you want that user can choose between different lengths of the event you can specify them here. Must include the provided `lengthInMinutes`." }, "locations": { "type": "array", "description": "Locations where the event will take place. If not provided, cal video link will be used as the location. Note: Setting a location to a conferencing app does not install the app - the app must already be installed. Via API, only Google Meet (google-meet), Microsoft Teams (office365-video), and Zoom (zoom) can be installed. Cal Video (cal-video) is installed by default. All other conferencing apps must be connected via the Cal.com web app and are not available for Platform plan customers. You can only set an event type location to an app that has already been installed or connected." }, "lockTimeZoneToggleOnBookingPage": { "type": "boolean", "description": "Lock Time Zone Toggle On Booking Page" }, "minimumBookingNotice": { "type": "number", "description": "Minimum number of minutes before the event that a booking can be made." }, "offsetStart": { "type": "number", "description": "Offset timeslots shown to bookers by a specified number of minutes" }, "onlyShowFirstAvailableSlot": { "type": "boolean", "description": "This will limit your availability for this event type to one slot per day, scheduled at the earliest available time." }, "recurrence": { "description": "Create a recurring event type." }, "requiresBookerEmailVerification": { "type": "boolean", "description": "Requires Booker Email Verification" }, "rescheduleWithSameRoundRobinHost": { "type": "boolean", "description": "Rescheduled events will be assigned to the same host as initially scheduled." }, "scheduleId": { "type": "number", "description": "If you want that this event has different schedule than user's default one you can specify it here." }, "schedulingType": { "type": "string", "description": "The scheduling type for the team event - collective or roundRobin. ❗If you change scheduling type you must also provide `hosts` or `assignAllTeamMembers` in the request body, otherwise the event type will have no hosts - this is required because in case of collective event type all hosts are mandatory but in case of round robin some or non can be mandatory so we can't predict how you want the hosts to be setup which is why you must provide that information. If you want to convert round robin or collective into managed or managed into round robin or collective then you will have to create a new team event type and delete old one.", "enum": [ "collective", "roundRobin" ] }, "seats": { "description": "Create an event type with multiple seats." }, "showOptimizedSlots": { "type": "boolean", "description": "Arrange time slots to optimize availability." }, "slotInterval": { "type": "number", "description": "Number representing length of each slot when event is booked. By default it equal length of the event type. If event length is 60 minutes then we would have slots 9AM, 10AM, 11AM etc. but if it was changed to 30 minutes then we would have slots 9AM, 9:30AM, 10AM, 10:30AM etc. as the available times to book the 60 minute event." }, "slug": { "type": "string", "description": "The slug value" }, "successRedirectUrl": { "type": "string", "description": "A valid URL where the booker will redirect to, once the booking is completed successfully" }, "title": { "type": "string", "description": "The title value" }, "useDestinationCalendarEmail": { "type": "boolean", "description": "Use Destination Calendar Email" } }, "required": [ "PCID", "teamId", "eventTypeId" ] } ``` *** ## cal\_teams\_memberships\_controller\_create\_team\_membership Create a membership **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------- | -------- | ------- | --------------------- | | `teamId` | number | Yes | — | Team Id | | `accepted` | boolean | No | — | The accepted value | | `disableImpersonation` | boolean | No | — | Disable Impersonation | | `role` | string | No | — | The role value | | `userId` | number | Yes | — | User Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "teamId": { "type": "number", "description": "Team Id" }, "accepted": { "type": "boolean", "description": "The accepted value" }, "disableImpersonation": { "type": "boolean", "description": "Disable Impersonation" }, "role": { "type": "string", "description": "The role value", "enum": [ "MEMBER", "OWNER", "ADMIN" ] }, "userId": { "type": "number", "description": "User Id" } }, "required": [ "PCID", "teamId", "userId" ] } ``` *** ## cal\_teams\_memberships\_controller\_delete\_team\_membership Delete a membership **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | ------------- | | `teamId` | number | Yes | — | Team Id | | `membershipId` | number | Yes | — | Membership Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "teamId": { "type": "number", "description": "Team Id" }, "membershipId": { "type": "number", "description": "Membership Id" } }, "required": [ "PCID", "teamId", "membershipId" ] } ``` *** ## cal\_teams\_memberships\_controller\_get\_team\_membership Get a membership **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ------ | -------- | ------- | ------------- | | `teamId` | number | Yes | — | Team Id | | `membershipId` | number | Yes | — | Membership Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "teamId": { "type": "number", "description": "Team Id" }, "membershipId": { "type": "number", "description": "Membership Id" } }, "required": [ "PCID", "teamId", "membershipId" ] } ``` *** ## cal\_teams\_memberships\_controller\_get\_team\_memberships Get all memberships **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | `teamId` | number | Yes | — | Team Id | | `take` | number | No | — | Maximum number of items to return | | `skip` | number | No | — | Number of items to skip | | `emails` | string\[] | No | — | Filter team memberships by email addresses. If you want to filter by multiple emails, separate them with a comma (max 20 emails for performance). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "teamId": { "type": "number", "description": "Team Id" }, "take": { "type": "number", "description": "Maximum number of items to return" }, "skip": { "type": "number", "description": "Number of items to skip" }, "emails": { "type": "array", "items": { "type": "string" }, "description": "Filter team memberships by email addresses. If you want to filter by multiple emails, separate them with a comma (max 20 emails for performance)." } }, "required": [ "PCID", "teamId" ] } ``` *** ## cal\_teams\_memberships\_controller\_update\_team\_membership Update membership **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------------- | ------- | -------- | ------- | --------------------- | | `teamId` | number | Yes | — | Team Id | | `membershipId` | number | Yes | — | Membership Id | | `accepted` | boolean | No | — | The accepted value | | `disableImpersonation` | boolean | No | — | Disable Impersonation | | `role` | string | No | — | The role value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "teamId": { "type": "number", "description": "Team Id" }, "membershipId": { "type": "number", "description": "Membership Id" }, "accepted": { "type": "boolean", "description": "The accepted value" }, "disableImpersonation": { "type": "boolean", "description": "Disable Impersonation" }, "role": { "type": "string", "description": "The role value", "enum": [ "MEMBER", "OWNER", "ADMIN" ] } }, "required": [ "PCID", "teamId", "membershipId" ] } ```