Cal.com Conferencing API

openapi: 3.2.0
info:
  title: Cal.com API v2 Conferencing API
  description: ''
  version: 1.0.0
  contact: {}
servers: []
tags:
- name: Conferencing
paths:
  /v2/conferencing/{app}/connect:
    post:
      description: 'Only `google-meet` can be connected this way, and only for a user who already has a valid Google Calendar connection. Zoom and Microsoft Teams require an OAuth handshake - start it with `GET /v2/conferencing/{app}/oauth/auth-url` instead. Walkthrough: https://cal.com/docs/api-reference/v2/conferencing-apps. If accessed using an OAuth access token, the `APPS_WRITE` scope is required.'
      operationId: ConferencingController_connect
      parameters:
      - name: app
        required: true
        in: path
        description: Conferencing application type
        schema:
          enum:
          - google-meet
          type: string
      - name: Authorization
        in: header
        description: value must be `Bearer <token>` where `<token>` is api key prefixed with cal_, managed user access token, or OAuth access token
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConferencingAppOutputResponseDto'
      summary: Connect your conferencing application
      tags:
      - Conferencing
      x-oauth-scopes:
      - APPS_WRITE
  /v2/conferencing/{app}/oauth/auth-url:
    get:
      description: 'Returns the URL to send the user to so they can authorize Zoom or Microsoft Teams. Redirect the user''s browser to it - the provider then returns them to a callback already registered by Cal.com, which stores the credential against the owner of the access token that started the flow. `returnTo` and `onErrorReturnTo` must each be a relative path or an absolute http(s) URL. The returned URL expires 10 minutes after this call, so redirect immediately rather than caching it. Walkthrough: https://cal.com/docs/api-reference/v2/conferencing-apps. If accessed using an OAuth access token, the `APPS_WRITE` scope is required.'
      operationId: ConferencingController_redirect
      parameters:
      - name: Authorization
        required: true
        in: header
        description: value must be `Bearer <token>` where `<token>` is api key prefixed with cal_, managed user access token, or OAuth access token
        schema:
          type: string
      - name: app
        required: true
        in: path
        description: Conferencing application type
        schema:
          enum:
          - zoom
          - msteams
          type: string
      - name: returnTo
        required: true
        in: query
        schema:
          type: string
      - name: onErrorReturnTo
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConferencingAppsOauthUrlResponseDto'
      summary: Get OAuth conferencing app auth URL
      tags:
      - Conferencing
      x-oauth-scopes:
      - APPS_WRITE
  /v2/conferencing/{app}/oauth/callback:
    get:
      operationId: ConferencingController_save
      parameters:
      - name: state
        required: true
        in: query
        schema:
          type: string
      - name: app
        required: true
        in: path
        description: Conferencing application type
        schema:
          enum:
          - zoom
          - msteams
          type: string
      - name: code
        required: true
        in: query
        schema:
          type: string
      responses:
        '200':
          description: ''
      summary: Conferencing app OAuth callback
      tags:
      - Conferencing
      x-oauth-scopes: []
  /v2/conferencing:
    get:
      description: If accessed using an OAuth access token, the `APPS_READ` scope is required.
      operationId: ConferencingController_listInstalledConferencingApps
      parameters:
      - name: Authorization
        in: header
        description: value must be `Bearer <token>` where `<token>` is api key prefixed with cal_, managed user access token, or OAuth access token
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConferencingAppsOutputResponseDto'
      summary: List your conferencing applications
      tags:
      - Conferencing
      x-mcp:
        name: get_conferencing_apps
        guidance: List all conferencing applications connected to the authenticated user's account (e.g. Zoom, Google Meet, Cal Video).
      x-oauth-scopes:
      - APPS_READ
  /v2/conferencing/{app}/default:
    post:
      description: If accessed using an OAuth access token, the `APPS_WRITE` scope is required.
      operationId: ConferencingController_default
      parameters:
      - name: app
        required: true
        in: path
        description: Conferencing application type
        schema:
          enum:
          - google-meet
          - zoom
          - msteams
          - daily-video
          type: string
      - name: Authorization
        in: header
        description: value must be `Bearer <token>` where `<token>` is api key prefixed with cal_, managed user access token, or OAuth access token
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetDefaultConferencingAppOutputResponseDto'
      summary: Set your default conferencing application
      tags:
      - Conferencing
      x-oauth-scopes:
      - APPS_WRITE
  /v2/conferencing/default:
    get:
      description: If accessed using an OAuth access token, the `APPS_READ` scope is required.
      operationId: ConferencingController_getDefault
      parameters:
      - name: Authorization
        in: header
        description: value must be `Bearer <token>` where `<token>` is api key prefixed with cal_, managed user access token, or OAuth access token
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDefaultConferencingAppOutputResponseDto'
      summary: Get your default conferencing application
      tags:
      - Conferencing
      x-oauth-scopes:
      - APPS_READ
  /v2/conferencing/{app}/disconnect:
    delete:
      description: If accessed using an OAuth access token, the `APPS_WRITE` scope is required.
      operationId: ConferencingController_disconnect
      parameters:
      - name: app
        required: true
        in: path
        description: Conferencing application type
        schema:
          enum:
          - google-meet
          - zoom
          - msteams
          type: string
      - name: Authorization
        in: header
        description: value must be `Bearer <token>` where `<token>` is api key prefixed with cal_, managed user access token, or OAuth access token
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisconnectConferencingAppOutputResponseDto'
      summary: Disconnect your conferencing application
      tags:
      - Conferencing
      x-oauth-scopes:
      - APPS_WRITE
components:
  schemas:
    SetDefaultConferencingAppOutputResponseDto:
      type: object
      properties:
        status:
          enum:
          - success
          - error
          type: string
          example: success
      required:
      - status
    GetConferencingAppsOauthUrlResponseDto:
      type: object
      properties:
        status:
          type: string
          example: success
          enum:
          - success
          - error
      required:
      - status
    ConferencingAppOutputResponseDto:
      type: object
      properties:
        status:
          enum:
          - success
          - error
          type: string
        data:
          $ref: '#/components/schemas/ConferencingAppsOutputDto'
      required:
      - status
      - data
    DefaultConferencingAppsOutputDto:
      type: object
      properties:
        appSlug:
          type: string
        appLink:
          type: string
    ConferencingAppsOutputResponseDto:
      type: object
      properties:
        status:
          enum:
          - success
          - error
          type: string
        data:
          type: array
          items:
            $ref: '#/components/schemas/ConferencingAppsOutputDto'
      required:
      - status
      - data
    GetDefaultConferencingAppOutputResponseDto:
      type: object
      properties:
        status:
          enum:
          - success
          - error
          type: string
          example: success
        data:
          $ref: '#/components/schemas/DefaultConferencingAppsOutputDto'
      required:
      - status
    DisconnectConferencingAppOutputResponseDto:
      type: object
      properties:
        status:
          enum:
          - success
          - error
          type: string
          example: success
      required:
      - status
    ConferencingAppsOutputDto:
      type: object
      properties:
        id:
          type: number
          description: Id of the conferencing app credentials
        type:
          type: string
          example: google_video
          description: Type of conferencing app
        userId:
          type: number
          description: Id of the user associated to the conferencing app
        invalid:
          type:
          - boolean
          - 'null'
          example: true
          description: Whether if the connection is working or not.
      required:
      - id
      - type
      - userId
x-provenance:
  method: harvested
  publisher: Cal.com
  source: https://cal.com/docs/api-reference/v2/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)