Cal.com Orgs / Users / Conferencing API

openapi: 3.2.0
info:
  title: Cal.com API v2 Orgs / Users / Conferencing API
  description: ''
  version: 1.0.0
  contact: {}
servers: []
tags:
- name: Orgs / Users / Conferencing
paths:
  /v2/organizations/{orgId}/users/{userId}/conferencing:
    get:
      description: Lists all connected conferencing apps for a specific user within the organization, including which one is set as default. If accessed using an OAuth access token, the `APPS_READ` scope is required.
      operationId: OrganizationsUsersConferencingController_listConferencingApps
      parameters:
      - name: Authorization
        in: header
        description: For non-platform customers - value must be `Bearer <token>` where `<token>` is api key prefixed with cal_
        required: false
        schema:
          type: string
      - name: x-cal-secret-key
        in: header
        description: For platform customers - OAuth client secret key
        required: false
        schema:
          type: string
      - name: x-cal-client-id
        in: header
        description: For platform customers - OAuth client ID
        required: false
        schema:
          type: string
      - name: userId
        required: true
        in: path
        schema:
          type: number
      - name: orgId
        required: true
        in: path
        schema:
          type: number
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConferencingAppsWithDefaultOutputResponseDto'
      summary: List conferencing apps of an organization user
      tags:
      - Orgs / Users / Conferencing
      x-oauth-scopes:
      - APPS_READ
      x-platform-plan: ESSENTIALS
  /v2/organizations/{orgId}/users/{userId}/conferencing/default:
    post:
      description: Sets the default conferencing app for a specific user within the organization. If accessed using an OAuth access token, the `APPS_WRITE` scope is required.
      operationId: OrganizationsUsersConferencingController_setDefaultConferencingApp
      parameters:
      - name: Authorization
        in: header
        description: For non-platform customers - value must be `Bearer <token>` where `<token>` is api key prefixed with cal_
        required: false
        schema:
          type: string
      - name: x-cal-secret-key
        in: header
        description: For platform customers - OAuth client secret key
        required: false
        schema:
          type: string
      - name: x-cal-client-id
        in: header
        description: For platform customers - OAuth client ID
        required: false
        schema:
          type: string
      - name: userId
        required: true
        in: path
        schema:
          type: number
      - name: orgId
        required: true
        in: path
        schema:
          type: number
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetDefaultConferencingAppInput'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetDefaultConferencingAppOutputResponseDto'
      summary: Set the default conferencing app for an organization user
      tags:
      - Orgs / Users / Conferencing
      x-oauth-scopes:
      - APPS_WRITE
      x-platform-plan: ESSENTIALS
components:
  schemas:
    ConferencingAppsWithDefaultOutputDto:
      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.
        appSlug:
          type: string
          example: google-meet
          description: Slug of the conferencing app
        isDefault:
          type: boolean
          example: false
          description: Whether this app is the user's default conferencing app
      required:
      - id
      - type
      - userId
      - appSlug
      - isDefault
    ConferencingAppsWithDefaultOutputResponseDto:
      type: object
      properties:
        status:
          enum:
          - success
          - error
          type: string
        data:
          type: array
          items:
            $ref: '#/components/schemas/ConferencingAppsWithDefaultOutputDto'
      required:
      - status
      - data
    SetDefaultConferencingAppOutputResponseDto:
      type: object
      properties:
        status:
          enum:
          - success
          - error
          type: string
          example: success
      required:
      - status
    SetDefaultConferencingAppInput:
      type: object
      properties:
        appSlug:
          type: string
          description: The slug of the conferencing app to set as default
          example: google-meet
          enum:
          - google-meet
          - zoom
          - msteams
          - daily-video
      required:
      - appSlug
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)