Skip to main content
POST
/
v2
/
organizations
/
{orgId}
/
teams
/
{teamId}
/
event-types
/
{eventTypeId}
/
private-links
Create a private link for a team event type
curl --request POST \
  --url https://api.cal.com/v2/organizations/{orgId}/teams/{teamId}/event-types/{eventTypeId}/private-links \
  --header 'Content-Type: application/json' \
  --data '
{
  "expiresAt": "2024-12-31T23:59:59.000Z",
  "maxUsageCount": 10
}
'
{
  "status": "success",
  "data": {
    "linkId": "abc123def456",
    "eventTypeId": 123,
    "isExpired": false,
    "bookingUrl": "https://cal.com/d/abc123def456/30min",
    "expiresAt": "2025-12-31T23:59:59.000Z"
  }
}

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

​
teamId
number
required
​
eventTypeId
number
required

Body

application/json
​
expiresAt
string<date-time>

Expiration date for time-based links

Example:

"2024-12-31T23:59:59.000Z"

​
maxUsageCount
number
default:1

Maximum number of times the link can be used. If omitted and expiresAt is not provided, defaults to 1 (one time use).

Required range: x >= 1
Example:

10

Response

201 - application/json
​
status
string
required

Response status

Example:

"success"

​
data
object
required

Created private link data (either time-based or usage-based)

  • Option 1
  • Option 2