Teams

The teams endpoint allows you to programmatically CRUD team data.

Team Object

Attribute	Description
id	integer The ID of the team, generated automatically
name	string The name of the team
slug	string The slug of the team
logoUrl	string The URL of the team's logo
calVideoLogo	string The URL of the Cal video logo for the team
appLogo	string The URL of the app logo for the team
appIconLogo	string The URL of the app icon logo for the team
bio	string The biography or description of the team
hideBranding	boolean Indicates whether branding is hidden for the team
isPrivate	boolean Indicates whether the team is private
hideBookATeamMember	boolean Indicates whether the 'Book a Team Member' option is hidden
members	Membership[] List of members in the team
eventTypes	EventType[] List of event types associated with the team
workflows	Workflow[] List of workflows associated with the team
createdAt	DateTime The date and time when the team was created
metadata	json Metadata associated with the team
theme	string The theme associated with the team
brandColor	string The brand color of the team
darkBrandColor	string The dark brand color of the team
verifiedNumbers	VerifiedNumber[] List of verified numbers associated with the team
verifiedEmails	VerifiedEmail[] List of verified emails associated with the team
bannerUrl	string The URL of the team's banner
parentId	integer The ID of the parent team, if any
parent	Team Object The parent team, if any
children	Team[] List of child teams under this team
orgUsers	User[] List of users in the organization's scope
inviteTokens	VerificationToken[] List of invite tokens associated with the team
webhooks	Webhook[] List of webhooks associated with the team
timeFormat	integer Time format used by the team
timeZone	string Time zone associated with the team
weekStart	string The start day of the week for the team
routingForms	App_RoutingForms_Form[] List of routing forms associated with the team
apiKeys	ApiKey[] List of API keys associated with the team
credentials	Credential[] List of credentials associated with the team
accessCodes	AccessCode[] List of access codes associated with the team
isOrganization	boolean Indicates whether the team is an organization
organizationSettings	OrganizationSettings Object Settings for the organization associated with the team
instantMeetingTokens	InstantMeetingToken[] List of instant meeting tokens associated with the team
orgProfiles	Profile[] List of profiles associated with the organization
pendingPayment	boolean Indicates whether there is a pending payment for the team
dsyncTeamGroupMapping	DSyncTeamGroupMapping[] List of DSync team group mappings associated with the team
isPlatform	boolean Indicates whether the team is part of the platform
platformOAuthClient	PlatformOAuthClient[] List of platform OAuth clients associated with the team
smsLockState	SMSLockState The SMS lock state of the team
platformBilling	PlatformBilling Object Billing information for the platform associated with the team
activeOrgWorkflows	WorkflowsOnTeams[] List of active organization workflows associated with the team

Example Team Object

{
    "id": 1234,
    "name": "Development Team",
    "slug": "development-team",
    "logoUrl": "https://example.com/logos/dev-team-logo.png",
    "calVideoLogo": "https://example.com/logos/cal-video-logo.png",
    "appLogo": "https://example.com/logos/app-logo.png",
    "appIconLogo": "https://example.com/logos/app-icon-logo.png",
    "bio": "This team focuses on developing new features and improving the platform.",
    "hideBranding": false,
    "isPrivate": true,
    "hideBookATeamMember": false,
    "members": [Membership Object[]],
    "eventTypes": [EventType Object[]],
    "workflows": [Workflow Object[]],
    "createdAt": "2024-07-01T12:00:00Z",
    "metadata": [Metadata Object],
    "theme": "light",
    "brandColor": "#FF5733",
    "darkBrandColor": "#C70039",
    "verifiedNumbers": [VerifiedNumber Object[]],
    "verifiedEmails": [VerifiedEmail Object[]],
    "bannerUrl": "https://example.com/banners/dev-team-banner.png",
    "parentId": 5678,
    "parent": [Team Object],
    "children": [Team Object[]],
    "orgUsers": [User Object[]],
    "inviteTokens": [VerificationToken Object[]],
    "webhooks": [Webhook Object[]],
    "timeFormat": 24,
    "timeZone": "America/New_York",
    "weekStart": "Monday",
    "routingForms": [App_RoutingForms_Form Object[]],
    "apiKeys": [ApiKey Object[]],
    "credentials": [Credential Object[]],
    "accessCodes": [AccessCode Object[]],
    "isOrganization": true,
    "organizationSettings": [OrganizationSettings Object],
    "instantMeetingTokens": [InstantMeetingToken Object[]],
    "orgProfiles": [Profile Object[]],
    "pendingPayment": false,
    "dsyncTeamGroupMapping": [DSyncTeamGroupMapping Object[]],
    "isPlatform": false,
    "platformOAuthClient": [PlatformOAuthClient Object[]],
    "smsLockState": "UNLOCKED",
    "platformBilling": [PlatformBilling Object],
    "activeOrgWorkflows": [WorkflowsOnTeams Object[]]
}

Find all teams

Get a list of all teams you are an owner or member of

GET

/teams

Create a new team

POST

/teams

Find a team

Get a specific team you are an owner or member of

GET

/teams/{teamId}

Edit an existing team

Modify details of an existing team that you are an owner of

PATCH

/teams/{teamId}

Remove an existing team

Remove a team you're an owner of

DELETE

/teams/{teamId}

Was this page helpful?

Slots

Users