Webex Hot Desk API

openapi: 3.2.0
info:
  title: Webex Hot Desk API
  version: 1.0.0
  description: 'Operations tagged Hot Desk across 3 of this provider''s published API definitions: webex-cloud-calling-openapi.json, webex-device-openapi.json, webex-hot-desk-api-openapi.yml. Each path carries the servers of the definition it was published in.'
  x-provenance:
    method: harvested
    authored_by: Cisco Webex
    harvested_by: API Evangelist
    harvested_on: '2026-08-19'
    first_party: true
    note: Published by Cisco. Retrieved unmodified except for this x-provenance block.
    provider_published: true
    derived_view: Per-tag view of webex-cloud-calling-openapi.json, the provider's source document. Operations and schemas are the provider's, unmodified; only the partition is ours.
    derived_from: webex-cloud-calling-openapi.json
    operation_coverage: 2/2
  x-evidence:
  - type: source
    url: https://github.com/webex/webex-openapi-specs/blob/main/public-spec/webex-cloud-calling.json
  - type: raw
    url: https://raw.githubusercontent.com/webex/webex-openapi-specs/main/public-spec/webex-cloud-calling.json
tags:
- name: Hot Desk
paths:
  /hotdesk/sessions:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HotDeskSessionsResponse'
              example:
                items:
                - sessionId: Y2lzY29...
                  workspaceId: YL34EmB...
                  personId: YL34EmA...
                  bookingStartTime: '2024-08-29T12:00:00Z'
                  bookingEndTime: '2024-08-29T20:00:00Z'
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.'
        '423':
          description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: List Sessions
      operationId: List Sessions
      description: 'List hot desk sessions.


        Use query parameters to filter the response.

        The `orgId` parameter is for use by partner administrators acting on a managed organization.

        The `personId` and `workspaceId` parameters are optional and are used to filter the response to only include sessions for a specific person or workspace.

        When used together they are used as an AND filter.'
      tags:
      - Hot Desk
      parameters:
      - name: orgId
        in: query
        description: List sessions in this organization. Only admin users of another organization (such as partners) may use this parameter.
        example: Y2lzY29...
        schema:
          type: string
      - name: personId
        in: query
        description: List sessions for this person.
        example: YL34EmA...
        schema:
          type: string
      - name: workspaceId
        in: query
        description: List sessions for this workspace.
        example: YL34EmB...
        schema:
          type: string
  /hotdesk/sessions/{sessionId}:
    delete:
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.'
        '423':
          description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: Delete Session
      operationId: Delete Session
      description: Delete a hot desk session.
      tags:
      - Hot Desk
      parameters:
      - name: sessionId
        in: path
        description: The unique identifier for the hot desk session.
        required: true
        example: Y2lzY29zcGFyazovL3VzL0hEU0VTU0lPTi9lZTY1NDQ5OC00OGU5LTQxMTItOWYxMi1lZmJiYTJkOTE4ZWV8MjAyNC0wNS0xMVQxMDowMDowMFo=
        schema:
          type: string
components:
  schemas:
    HotDesk:
      type: object
      properties:
        sessionId:
          type: string
          example: Y2lzY29...
          description: A unique identifier for a hot desk session.
        workspaceId:
          type: string
          example: YL34EmB...
          description: The workspace where the hot desk session is active.
        personId:
          type: string
          example: YL34EmA...
          description: The id of the person who initiated the hot desk session.
        bookingStartTime:
          type: string
          example: '2024-08-29T12:00:00Z'
          description: The start time of the booking.
        bookingEndTime:
          type: string
          example: '2024-08-29T20:00:00Z'
          description: The end time of the booking.
    HotDeskSessionsResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/HotDesk'
  securitySchemes:
    oauth2:
      flows:
        authorizationCode:
          authorizationUrl: /
          scopes: {}
          tokenUrl: /
      type: oauth2
    bearer-key:
      type: http
      description: e.g. Bearer YOUR_AUTHORIZATION_TOKEN
      scheme: bearer
      bearerFormat: JWT
    bearerAuth:
      type: http
      description: e.g. Bearer YOUR_AUTHORIZATION_TOKEN
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- webex-cloud-calling-openapi.json
- webex-device-openapi.json
- webex-hot-desk-api-openapi.yml