Cal.com

Cal.com Event Types Private Links API

The Event Types Private Links API from Cal.com — 2 operation(s) for event types private links.

GitHub OpenAPI

Operations 4

Documentation

📖
Documentation
https://cal.com/docs/api-reference
📖
APIReference
https://cal.com/docs/api-reference/v2/bookings
📖
APIReference
https://cal.com/docs/api-reference/v2/event-types
📖
APIReference
https://cal.com/docs/api-reference/v2/schedules
📖
APIReference
https://cal.com/docs/api-reference/v2/availability
📖
APIReference
https://cal.com/docs/api-reference/v2/slots
📖
APIReference
https://cal.com/docs/api-reference/v2/webhooks
📖
APIReference
https://cal.com/docs/api-reference/v2/oauth
📖
APIReference
https://cal.com/docs/api-reference/v2/teams
📖
APIReference
https://cal.com/docs/api-reference/v2/organizations
📖
APIReference
https://cal.com/docs/api-reference/v2/out-of-office
📖
APIReference
https://cal.com/docs/api-reference/v2/conferencing
📖
APIReference
https://cal.com/docs/api-reference/v2/destination-calendars
📖
Documentation
https://cal.com/docs/platform

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cal-com/refs/heads/main/openapi/cal-com-event-types-private-links-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/cal-com/refs/heads/main/asyncapi/cal-com-webhooks-asyncapi.yaml

Other Resources

🔗
SDKs
https://www.npmjs.com/package/@calcom/atoms

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/cal-com-event-types-private-links-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cal-com-event-types-private-links-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Cal.diy API v2 Api Keys Event Types Private Links API
  description: ''
  version: 1.0.0
  contact: {}
servers: []
tags:
- name: Event Types Private Links
paths:
  /v2/event-types/{eventTypeId}/private-links:
    post:
      operationId: EventTypesPrivateLinksController_createPrivateLink
      summary: Create a private link for an event type
      parameters:
      - name: eventTypeId
        required: true
        in: path
        schema:
          type: number
      - name: Authorization
        in: header
        description: value must be `Bearer <token>` where `<token>` is api key prefixed with cal_ or managed user access token
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePrivateLinkInput'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePrivateLinkOutput'
      tags:
      - Event Types Private Links
    get:
      operationId: EventTypesPrivateLinksController_getPrivateLinks
      summary: Get all private links for an event type
      parameters:
      - name: eventTypeId
        required: true
        in: path
        schema:
          type: number
      - name: Authorization
        in: header
        description: value must be `Bearer <token>` where `<token>` is api key prefixed with cal_ or managed user access token
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPrivateLinksOutput'
      tags:
      - Event Types Private Links
  /v2/event-types/{eventTypeId}/private-links/{linkId}:
    patch:
      operationId: EventTypesPrivateLinksController_updatePrivateLink
      summary: Update a private link for an event type
      parameters:
      - name: eventTypeId
        required: true
        in: path
        schema:
          type: number
      - name: linkId
        required: true
        in: path
        schema:
          type: string
      - name: Authorization
        in: header
        description: value must be `Bearer <token>` where `<token>` is api key prefixed with cal_ or managed user access token
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePrivateLinkBody'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePrivateLinkOutput'
      tags:
      - Event Types Private Links
    delete:
      operationId: EventTypesPrivateLinksController_deletePrivateLink
      summary: Delete a private link for an event type
      parameters:
      - name: eventTypeId
        required: true
        in: path
        schema:
          type: number
      - name: linkId
        required: true
        in: path
        schema:
          type: string
      - name: Authorization
        in: header
        description: value must be `Bearer <token>` where `<token>` is api key prefixed with cal_ or managed user access token
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletePrivateLinkOutput'
      tags:
      - Event Types Private Links
components:
  schemas:
    CreatePrivateLinkInput:
      type: object
      properties:
        expiresAt:
          type: string
          description: Expiration date for time-based links
          format: date-time
          example: '2024-12-31T23:59:59.000Z'
        maxUsageCount:
          type: number
          description: Maximum number of times the link can be used. If omitted and expiresAt is not provided, defaults to 1 (one time use).
          example: 10
          minimum: 1
          default: 1
    CreatePrivateLinkOutput:
      type: object
      properties:
        status:
          type: string
          description: Response status
          example: success
        data:
          description: Created private link data (either time-based or usage-based)
          oneOf:
          - $ref: '#/components/schemas/TimeBasedPrivateLinkOutput'
          - $ref: '#/components/schemas/UsageBasedPrivateLinkOutput'
      required:
      - status
      - data
    UpdatePrivateLinkOutput:
      type: object
      properties:
        status:
          type: string
          description: Response status
          example: success
        data:
          description: Updated private link data (either time-based or usage-based)
          oneOf:
          - $ref: '#/components/schemas/TimeBasedPrivateLinkOutput'
          - $ref: '#/components/schemas/UsageBasedPrivateLinkOutput'
      required:
      - status
      - data
    GetPrivateLinksOutput:
      type: object
      properties:
        status:
          type: string
          description: Response status
          example: success
        data:
          type: array
          description: Array of private links for the event type (mix of time-based and usage-based)
          items:
            oneOf:
            - $ref: '#/components/schemas/TimeBasedPrivateLinkOutput'
            - $ref: '#/components/schemas/UsageBasedPrivateLinkOutput'
      required:
      - status
      - data
    TimeBasedPrivateLinkOutput:
      type: object
      properties:
        linkId:
          type: string
          description: The private link ID
          example: abc123def456
        eventTypeId:
          type: number
          description: Event type ID this link belongs to
          example: 123
        isExpired:
          type: boolean
          description: Whether the link is currently expired
          example: false
        bookingUrl:
          type: string
          description: Full booking URL for this private link
          format: uri
          example: https://cal.com/d/abc123def456/30min
        expiresAt:
          type: string
          description: Expiration date for this time-based link
          format: date-time
          example: '2025-12-31T23:59:59.000Z'
      required:
      - linkId
      - eventTypeId
      - isExpired
      - bookingUrl
      - expiresAt
    UpdatePrivateLinkBody:
      type: object
      properties:
        expiresAt:
          format: date-time
          type: string
          description: New expiration date for time-based links
          example: '2024-12-31T23:59:59.000Z'
        maxUsageCount:
          type: number
          description: New maximum number of times the link can be used
          example: 10
          minimum: 1
    DeletePrivateLinkOutput:
      type: object
      properties:
        status:
          type: string
          description: Response status
          example: success
        data:
          type: object
          description: Deleted link information
          properties:
            linkId:
              type: string
              example: abc123def456
            message:
              type: string
              example: Private link deleted successfully
      required:
      - status
      - data
    UsageBasedPrivateLinkOutput:
      type: object
      properties:
        linkId:
          type: string
          description: The private link ID
          example: abc123def456
        eventTypeId:
          type: number
          description: Event type ID this link belongs to
          example: 123
        isExpired:
          type: boolean
          description: Whether the link is currently expired
          example: false
        bookingUrl:
          type: string
          description: Full booking URL for this private link
          format: uri
          example: https://cal.com/d/abc123def456/30min
        maxUsageCount:
          type: number
          description: Maximum number of times this link can be used
          example: 10
        usageCount:
          type: number
          description: Current usage count for this link
          example: 3
      required:
      - linkId
      - eventTypeId
      - isExpired
      - bookingUrl
      - maxUsageCount
      - usageCount