Skip to main content
POST
/
v2
/
organizations
/
{orgId}
/
teams
Create a team
curl --request POST \
  --url https://api.cal.com/v2/organizations/{orgId}/teams \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "CalTeam",
  "slug": "caltel",
  "logoUrl": "https://i.cal.com/api/avatar/b0b58752-68ad-4c0d-8024-4fa382a77752.png",
  "calVideoLogo": "<string>",
  "appLogo": "<string>",
  "appIconLogo": "<string>",
  "bio": "<string>",
  "hideBranding": false,
  "isPrivate": true,
  "hideBookATeamMember": true,
  "metadata": {
    "key": "value"
  },
  "theme": "<string>",
  "brandColor": "<string>",
  "darkBrandColor": "<string>",
  "bannerUrl": "https://i.cal.com/api/avatar/949be534-7a88-4185-967c-c020b0c0bef3.png",
  "timeFormat": 123,
  "timeZone": "America/New_York",
  "weekStart": "Monday",
  "autoAcceptCreator": true,
  "addCreatorAsOwner": true
}
'
{
  "status": "success",
  "data": {
    "id": 123,
    "name": "<string>",
    "isOrganization": true,
    "parentId": 123,
    "slug": "<string>",
    "logoUrl": "<string>",
    "calVideoLogo": "<string>",
    "appLogo": "<string>",
    "appIconLogo": "<string>",
    "bio": "<string>",
    "hideBranding": true,
    "isPrivate": true,
    "hideBookATeamMember": false,
    "metadata": {
      "key": "value"
    },
    "theme": "<string>",
    "brandColor": "<string>",
    "darkBrandColor": "<string>",
    "bannerUrl": "<string>",
    "timeFormat": 123,
    "timeZone": "Europe/London",
    "weekStart": "Sunday"
  }
}

Headers

​
Authorization
string

For non-platform customers - value must be Bearer <token> where <token> is api key prefixed with cal_

​
x-cal-secret-key
string

For platform customers - OAuth client secret key

​
x-cal-client-id
string

For platform customers - OAuth client ID

Path Parameters

​
orgId
number
required

Body

application/json
​
name
string
required

Name of the team. Maximum 155 characters. Cannot contain links or URLs.

Required string length: 1 - 155
Example:

"CalTeam"

​
slug
string

Team slug in kebab-case - if not provided will be generated automatically based on name.

Example:

"caltel"

​
logoUrl
string

URL of the teams logo image

Example:

"https://i.cal.com/api/avatar/b0b58752-68ad-4c0d-8024-4fa382a77752.png"

​
bio
string
​
hideBranding
boolean
default:false
​
isPrivate
boolean
​
hideBookATeamMember
boolean
​
metadata
object

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.

Example:
{ "key": "value" }
​
theme
string
​
brandColor
string
​
darkBrandColor
string
​
bannerUrl
string

URL of the teams banner image which is shown on booker

Example:

"https://i.cal.com/api/avatar/949be534-7a88-4185-967c-c020b0c0bef3.png"

​
timeFormat
number
​
timeZone
string
default:Europe/London

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.

Example:

"America/New_York"

​
weekStart
string
default:Sunday
Example:

"Monday"

​
autoAcceptCreator
boolean
default:true

If you are a platform customer, don't pass 'false', because then team creator won't be able to create team event types.

​
addCreatorAsOwner
boolean
default:true

Whether to create an OWNER membership on the team for the user associated with authentication credentials for this request. For example, if you authenticate with API key belonging to Bob, then Bob will have OWNER membership for the newly created team. Pass false to create the team without an OWNER membership for that user - e.g. so it isn't included when assignAllTeamMembers is used on round-robin events. Org admins/owners can still manage the team and its event types without being a team member.

Response

201 - application/json
​
status
enum<string>
required
Available options:
success,
error
Example:

"success"

​
data
object
required