Skip to main content
Server path: /cal-teams | Type: Application | PCID required: Yes

Tools


cal_teams_controller_create_team

Create a team Parameters:
ParameterTypeRequiredDefaultDescription
appIconLogostringNoappIconLogo
appLogostringNoappLogo
autoAcceptCreatorbooleanNoIf you are a platform customer, don’t pass ‘false’, because then team creator won’t be able to create team event types.
bannerUrlstringNoURL of the teams banner image which is shown on booker
biostringNobio
brandColorstringNobrandColor
calVideoLogostringNocalVideoLogo
darkBrandColorstringNodarkBrandColor
hideBookATeamMemberbooleanNohideBookATeamMember
hideBrandingbooleanNohideBranding
isPrivatebooleanNoisPrivate
logoUrlstringNoURL of the teams logo image
metadataobjectNoYou 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.
namestringYesName of the team
slugstringNoTeam slug in kebab-case - if not provided will be generated automatically based on name.
themestringNotheme
timeFormatnumberNotimeFormat
timeZonestringNoTimezone 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.
weekStartstringNoweekStart

cal_teams_controller_delete_team

Delete a team Parameters:
ParameterTypeRequiredDefaultDescription
teamIdnumberYesteamId

cal_teams_controller_get_team

Get a team Parameters:
ParameterTypeRequiredDefaultDescription
teamIdnumberYesteamId

cal_teams_controller_get_teams

Get teams

cal_teams_controller_update_team

Update a team Parameters:
ParameterTypeRequiredDefaultDescription
teamIdnumberYesteamId
appIconLogostringNoappIconLogo
appLogostringNoappLogo
bannerUrlstringNoURL of the teams banner image which is shown on booker
biostringNobio
bookingLimitsstringNobookingLimits
brandColorstringNobrandColor
calVideoLogostringNocalVideoLogo
darkBrandColorstringNodarkBrandColor
hideBookATeamMemberbooleanNohideBookATeamMember
hideBrandingbooleanNohideBranding
includeManagedEventsInLimitsbooleanNoincludeManagedEventsInLimits
isPrivatebooleanNoisPrivate
logoUrlstringNoURL of the teams logo image
metadataobjectNoYou 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.
namestringNoName of the team
slugstringNoTeam slug
themestringNotheme
timeFormatnumberNotimeFormat
timeZonestringNoTimezone 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.
weekStartstringNoweekStart

cal_teams_event_types_controller_create_phone_call

Create a phone call Parameters:
ParameterTypeRequiredDefaultDescription
eventTypeIdnumberYeseventTypeId
orgIdnumberYesorgId
teamIdnumberYesteamId
beginMessagestringNoBegin message
calApiKeystringYesCAL API Key
enabledobjectYesEnabled status
generalPromptstringNoGeneral prompt
guestCompanystringNoGuest company
guestEmailstringNoGuest email
guestNamestringNoGuest name
numberToCallstringYesNumber to call
schedulerNamestringNoScheduler name
templateTypestringYesTemplate type
yourPhoneNumberstringYesYour phone number

cal_teams_event_types_controller_create_team_event_type

Create an event type Parameters:
ParameterTypeRequiredDefaultDescription
teamIdnumberYesteamId
afterEventBuffernumberNoExtra 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.
allowReschedulingCancelledBookingsbooleanNoWhen enabled, users will be able to create a new booking when trying to reschedule a cancelled booking.
allowReschedulingPastBookingsbooleanNoEnabling this option allows for past events to be rescheduled.
assignAllTeamMembersbooleanNoIf true, all current and future team members will be assigned to this event type. Provide either assignAllTeamMembers or hosts but not both
beforeEventBuffernumberNoExtra time automatically blocked on your calendar before a meeting starts. This gives you time to prepare, review notes, or transition from your previous activity.
bookerActiveBookingsLimitobjectNoLimit the number of active bookings a booker can make for this event type.
bookerLayoutsobjectNoShould booker have week, month or column view. Specify default layout and enabled layouts user can pick.
bookingFieldsany[]NoCustom 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.
bookingLimitsCountobjectNoLimit how many times this event can be booked
bookingLimitsDurationobjectNoLimit total amount of time that this event can be booked
bookingRequiresAuthenticationbooleanNoBoolean 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.
bookingWindowobjectNoLimit how far in the future this event can be booked
calVideoSettingsobjectNoCal 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.
colorobjectNocolor
confirmationPolicyobjectNoSpecify how the booking needs to be manually confirmed before it is pushed to the integrations and a confirmation mail is sent.
customNamestringNoCustomizable 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}
descriptionstringNodescription
destinationCalendarobjectNodestinationCalendar
disableCancellingobjectNoSettings for disabling cancelling of this event type.
disableGuestsbooleanNoIf true, person booking this event can’t add guests via their emails.
disableReschedulingobjectNoSettings for disabling rescheduling of this event type. Can be always disabled or disabled when less than X minutes before the meeting.
emailSettingsobjectNoEmail settings for this event type - only available for organization team event types.
hiddenbooleanNohidden
hideCalendarEventDetailsbooleanNohideCalendarEventDetails
hideCalendarNotesbooleanNohideCalendarNotes
hideOrganizerEmailbooleanNoBoolean to Hide organizer’s email address from the booking screen, email notifications, and calendar events
hostsany[]NoHosts 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
interfaceLanguagestringNoSet preferred language for the booking interface. Use empty string for visitor’s browser language (default).
lengthInMinutesnumberYeslengthInMinutes
lengthInMinutesOptionsany[]NoIf you want that user can choose between different lengths of the event you can specify them here. Must include the provided lengthInMinutes.
locationsany[]NoLocations 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.
lockTimeZoneToggleOnBookingPagebooleanNolockTimeZoneToggleOnBookingPage
minimumBookingNoticenumberNoMinimum number of minutes before the event that a booking can be made.
offsetStartnumberNoOffset timeslots shown to bookers by a specified number of minutes
onlyShowFirstAvailableSlotbooleanNoThis will limit your availability for this event type to one slot per day, scheduled at the earliest available time.
recurrenceobjectNoCreate a recurring event type.
requiresBookerEmailVerificationbooleanNorequiresBookerEmailVerification
rescheduleWithSameRoundRobinHostbooleanNoRescheduled events will be assigned to the same host as initially scheduled.
scheduleIdnumberNoIf you want that this event has different schedule than user’s default one you can specify it here.
schedulingTypestringYesThe scheduling type for the team event - collective, roundRobin or managed.
seatsobjectNoCreate an event type with multiple seats.
showOptimizedSlotsbooleanNoArrange time slots to optimize availability.
slotIntervalnumberNoNumber 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.
slugstringYesslug
successRedirectUrlstringNoA valid URL where the booker will redirect to, once the booking is completed successfully
titlestringYestitle
useDestinationCalendarEmailbooleanNouseDestinationCalendarEmail

cal_teams_event_types_controller_delete_team_event_type

Delete a team event type Parameters:
ParameterTypeRequiredDefaultDescription
teamIdnumberYesteamId
eventTypeIdnumberYeseventTypeId

cal_teams_event_types_controller_get_team_event_type

Get an event type Parameters:
ParameterTypeRequiredDefaultDescription
teamIdnumberYesteamId
eventTypeIdnumberYeseventTypeId

cal_teams_event_types_controller_get_team_event_types

Get team event types Parameters:
ParameterTypeRequiredDefaultDescription
teamIdnumberYesteamId
eventSlugstringNoSlug of team event type to return.
hostsLimitnumberNoSpecifies the maximum number of hosts to include in the response. This limit helps optimize performance. If not provided, all Hosts will be fetched.
sortCreatedAtstringNoSort event types by creation date. When not provided, no explicit ordering is applied.

cal_teams_event_types_controller_update_team_event_type

Update a team event type Parameters:
ParameterTypeRequiredDefaultDescription
teamIdnumberYesteamId
eventTypeIdnumberYeseventTypeId
afterEventBuffernumberNoExtra 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.
allowReschedulingCancelledBookingsbooleanNoWhen enabled, users will be able to create a new booking when trying to reschedule a cancelled booking.
allowReschedulingPastBookingsbooleanNoEnabling this option allows for past events to be rescheduled.
assignAllTeamMembersbooleanNoIf true, all current and future team members will be assigned to this event type. Provide either assignAllTeamMembers or hosts but not both
beforeEventBuffernumberNoExtra time automatically blocked on your calendar before a meeting starts. This gives you time to prepare, review notes, or transition from your previous activity.
bookerActiveBookingsLimitobjectNoLimit the number of active bookings a booker can make for this event type.
bookerLayoutsobjectNoShould booker have week, month or column view. Specify default layout and enabled layouts user can pick.
bookingFieldsany[]NoComplete 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.
bookingLimitsCountobjectNoLimit how many times this event can be booked
bookingLimitsDurationobjectNoLimit total amount of time that this event can be booked
bookingRequiresAuthenticationbooleanNoBoolean 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.
bookingWindowobjectNoLimit how far in the future this event can be booked
calVideoSettingsobjectNoCal video settings for the event type
colorobjectNocolor
confirmationPolicyobjectNoSpecify how the booking needs to be manually confirmed before it is pushed to the integrations and a confirmation mail is sent.
customNamestringNoCustomizable 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}
descriptionstringNodescription
destinationCalendarobjectNodestinationCalendar
disableCancellingobjectNoSettings for disabling cancelling of this event type.
disableGuestsbooleanNoIf true, person booking this event can’t add guests via their emails.
disableReschedulingobjectNoSettings for disabling rescheduling of this event type. Can be always disabled or disabled when less than X minutes before the meeting.
emailSettingsobjectNoEmail settings for this event type. Only available for organization team event types.
hiddenbooleanNohidden
hideCalendarEventDetailsbooleanNohideCalendarEventDetails
hideCalendarNotesbooleanNohideCalendarNotes
hideOrganizerEmailbooleanNoBoolean to Hide organizer’s email address from the booking screen, email notifications, and calendar events
hostsany[]NoHosts 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
interfaceLanguagestringNoSet preferred language for the booking interface. Use empty string for visitor’s browser language (default).
lengthInMinutesnumberNolengthInMinutes
lengthInMinutesOptionsany[]NoIf you want that user can choose between different lengths of the event you can specify them here. Must include the provided lengthInMinutes.
locationsany[]NoLocations 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.
lockTimeZoneToggleOnBookingPagebooleanNolockTimeZoneToggleOnBookingPage
minimumBookingNoticenumberNoMinimum number of minutes before the event that a booking can be made.
offsetStartnumberNoOffset timeslots shown to bookers by a specified number of minutes
onlyShowFirstAvailableSlotbooleanNoThis will limit your availability for this event type to one slot per day, scheduled at the earliest available time.
recurrenceobjectNoCreate a recurring event type.
requiresBookerEmailVerificationbooleanNorequiresBookerEmailVerification
rescheduleWithSameRoundRobinHostbooleanNoRescheduled events will be assigned to the same host as initially scheduled.
scheduleIdnumberNoIf you want that this event has different schedule than user’s default one you can specify it here.
schedulingTypestringNoThe 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.
seatsobjectNoCreate an event type with multiple seats.
showOptimizedSlotsbooleanNoArrange time slots to optimize availability.
slotIntervalnumberNoNumber 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.
slugstringNoslug
successRedirectUrlstringNoA valid URL where the booker will redirect to, once the booking is completed successfully
titlestringNotitle
useDestinationCalendarEmailbooleanNouseDestinationCalendarEmail

cal_teams_memberships_controller_create_team_membership

Create a membership Parameters:
ParameterTypeRequiredDefaultDescription
teamIdnumberYesteamId
acceptedbooleanNoaccepted
disableImpersonationbooleanNodisableImpersonation
rolestringNorole
userIdnumberYesuserId

cal_teams_memberships_controller_delete_team_membership

Delete a membership Parameters:
ParameterTypeRequiredDefaultDescription
teamIdnumberYesteamId
membershipIdnumberYesmembershipId

cal_teams_memberships_controller_get_team_membership

Get a membership Parameters:
ParameterTypeRequiredDefaultDescription
teamIdnumberYesteamId
membershipIdnumberYesmembershipId

cal_teams_memberships_controller_get_team_memberships

Get all memberships Parameters:
ParameterTypeRequiredDefaultDescription
teamIdnumberYesteamId
takenumberNoMaximum number of items to return
skipnumberNoNumber of items to skip
emailsany[]NoFilter team memberships by email addresses. If you want to filter by multiple emails, separate them with a comma (max 20 emails for performance).

cal_teams_memberships_controller_update_team_membership

Update membership Parameters:
ParameterTypeRequiredDefaultDescription
teamIdnumberYesteamId
membershipIdnumberYesmembershipId
acceptedbooleanNoaccepted
disableImpersonationbooleanNodisableImpersonation
rolestringNorole