Webex Features: Hot Desking Members API

openapi: 3.2.0
info:
  title: 'Webex Cloud Calling Features: Hot Desking Members API'
  version: 1.0.0
  description: The Webex Cloud Calling APIs enable comprehensive management of cloud-based calling services, including user provisioning, device assignment, call routing, feature configuration, and number management. These APIs facilitate integration with enterprise directories, automation of telephony workflows, and centralized management of global calling infrastructure. Use cases include automated onboarding, self-service portals, integration with CRM/ERP systems, and real-time monitoring of call quality and usage.
  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
  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: 'Features: Hot Desking Members'
paths:
  /telephony/config/people/{personId}/features/hotDesking/availableMembers:
    get:
      summary: Search Available Hot Desking Members
      operationId: searchAvailableHotDeskingMembers
      description: 'Retrieve members available for assignment to a person''s hot desking guest profile.


        Available members can include people, workspaces, and virtual lines that can be added as shared lines on the hot desking profile.


        This API requires a full, user, device, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`.'
      tags:
      - 'Features: Hot Desking Members'
      parameters:
      - $ref: '#/components/parameters/personId'
      - $ref: '#/components/parameters/orgId'
      - $ref: '#/components/parameters/locationId'
      - $ref: '#/components/parameters/max'
      - $ref: '#/components/parameters/start'
      - $ref: '#/components/parameters/memberName'
      - $ref: '#/components/parameters/phoneNumber'
      - $ref: '#/components/parameters/extension'
      - $ref: '#/components/parameters/order'
      responses:
        '200':
          description: OK
          headers:
            Link:
              description: Pagination link for the next page of available members, when additional results are available.
              schema:
                type: string
              example: <https://webexapis.com/v1/telephony/config/people/Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ/features/hotDesking/availableMembers?start=100&max=100>; rel="next"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HotDeskingAvailableMembers'
              example:
                members:
                - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk
                  firstName: John
                  lastName: Smith
                  phoneNumber: '+12055552221'
                  extension: '2221'
                  routingPrefix: '1234'
                  esn: '12342221'
                  lineType: SHARED_CALL_APPEARANCE
                  memberType: PEOPLE
                  location:
                    id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzJiNDkyZmZkLTRjNGItNGVmNS04YzAzLWE1MDYyYzM4NDA5Mw
                    name: Main Office
                - id: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS83MGY2MzYzMC1mZjlmLTExZWItODU5YS0xZjhiYjRjNzc3OGg
                  firstName: Support
                  lastName: Line
                  phoneNumber: '+12055552222'
                  extension: '2222'
                  routingPrefix: '1234'
                  esn: '12342222'
                  lineType: SHARED_CALL_APPEARANCE
                  memberType: VIRTUAL_LINE
                  location:
                    id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzJiNDkyZmZkLTRjNGItNGVmNS04YzAzLWE1MDYyYzM4NDA5Mw
                    name: Main Office
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '409':
          $ref: '#/components/responses/Conflict'
        '410':
          $ref: '#/components/responses/Gone'
        '415':
          $ref: '#/components/responses/UnsupportedMediaType'
        '423':
          $ref: '#/components/responses/Locked'
        '428':
          $ref: '#/components/responses/PreconditionRequired'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '502':
          $ref: '#/components/responses/BadGateway'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '504':
          $ref: '#/components/responses/GatewayTimeout'
      externalDocs:
        description: Webex Calling API Documentation
        url: https://developer.webex.com/docs/api/v1/webex-calling
  /telephony/config/people/{personId}/features/hotDesking/members:
    get:
      summary: Get Hot Desking Members
      operationId: getHotDeskingMembers
      description: 'Retrieve the primary and shared-line members assigned to a person''s hot desking guest profile.


        This API requires a full, user, device, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`.'
      tags:
      - 'Features: Hot Desking Members'
      parameters:
      - $ref: '#/components/parameters/personId'
      - $ref: '#/components/parameters/orgId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HotDeskingMembers'
              example:
                model: Business Communicator - PC
                members:
                - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ
                  firstName: Alice
                  lastName: Gomez
                  phoneNumber: '+12055552220'
                  extension: '2220'
                  routingPrefix: '1234'
                  esn: '12342220'
                  primaryOwner: true
                  port: 1
                  lineType: HOTDESKING_GUEST
                  lineWeight: 1
                  hotlineEnabled: false
                  allowCallDeclineEnabled: true
                  memberType: PEOPLE
                  location:
                    id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzJiNDkyZmZkLTRjNGItNGVmNS04YzAzLWE1MDYyYzM4NDA5Mw
                    name: Main Office
                - id: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS83MGY2MzYzMC1mZjlmLTExZWItODU5YS0xZjhiYjRjNzc3OGg
                  firstName: Support
                  lastName: Line
                  phoneNumber: '+12055552222'
                  extension: '2222'
                  routingPrefix: '1234'
                  esn: '12342222'
                  primaryOwner: false
                  port: 2
                  lineType: SHARED_CALL_APPEARANCE
                  lineWeight: 1
                  hotlineEnabled: false
                  allowCallDeclineEnabled: true
                  memberType: VIRTUAL_LINE
                  location:
                    id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzJiNDkyZmZkLTRjNGItNGVmNS04YzAzLWE1MDYyYzM4NDA5Mw
                    name: Main Office
                maxLineCount: 10
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '409':
          $ref: '#/components/responses/Conflict'
        '410':
          $ref: '#/components/responses/Gone'
        '415':
          $ref: '#/components/responses/UnsupportedMediaType'
        '423':
          $ref: '#/components/responses/Locked'
        '428':
          $ref: '#/components/responses/PreconditionRequired'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '502':
          $ref: '#/components/responses/BadGateway'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '504':
          $ref: '#/components/responses/GatewayTimeout'
      externalDocs:
        description: Webex Calling API Documentation
        url: https://developer.webex.com/docs/api/v1/webex-calling
    put:
      summary: Update Hot Desking Members
      operationId: updateHotDeskingMembers
      description: 'Modify the primary and shared-line members assigned to a person''s hot desking guest profile.


        The request replaces the hot desking profile member list with the members supplied in the request body.


        This API requires a full, user, device, or location administrator auth token with a scope of `spark-admin:telephony_config_write`.'
      tags:
      - 'Features: Hot Desking Members'
      parameters:
      - $ref: '#/components/parameters/personId'
      - $ref: '#/components/parameters/orgId'
      requestBody:
        description: Members to assign to the person's hot desking guest profile.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HotDeskingMembersPut'
            example:
              members:
              - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ
                port: 1
                primaryOwner: true
                lineType: HOTDESKING_GUEST
                lineWeight: 1
                hotlineEnabled: false
                allowCallDeclineEnabled: true
                memberType: USER
              - id: Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS83MGY2MzYzMC1mZjlmLTExZWItODU5YS0xZjhiYjRjNzc3OGg
                port: 2
                primaryOwner: false
                lineType: SHARED_CALL_APPEARANCE
                lineWeight: 1
                hotlineEnabled: false
                allowCallDeclineEnabled: true
                memberType: VIRTUAL_PROFILE
      responses:
        '204':
          description: No Content
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '409':
          $ref: '#/components/responses/Conflict'
        '410':
          $ref: '#/components/responses/Gone'
        '415':
          $ref: '#/components/responses/UnsupportedMediaType'
        '423':
          $ref: '#/components/responses/Locked'
        '428':
          $ref: '#/components/responses/PreconditionRequired'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '502':
          $ref: '#/components/responses/BadGateway'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '504':
          $ref: '#/components/responses/GatewayTimeout'
      externalDocs:
        description: Webex Calling API Documentation
        url: https://developer.webex.com/docs/api/v1/webex-calling
components:
  responses:
    Gone:
      description: 'Gone: The requested resource is no longer available.'
    Unauthorized:
      description: 'Unauthorized: Authentication credentials were missing or incorrect.'
    BadGateway:
      description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
    UnsupportedMediaType:
      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.'
    MethodNotAllowed:
      description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
    TooManyRequests:
      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.'
    Locked:
      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.'
    ServiceUnavailable:
      description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
    Forbidden:
      description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
    GatewayTimeout:
      description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
    BadRequest:
      description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
    InternalServerError:
      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).'
    Conflict:
      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.'
    NotFound:
      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.'
    PreconditionRequired:
      description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
  schemas:
    HotDeskingMembers:
      type: object
      description: Response containing the primary and shared-line members assigned to a person's hot desking guest profile.
      required:
      - members
      properties:
        model:
          type: string
          description: Name of the hot desking guest profile endpoint.
          example: Business Communicator - PC
        members:
          type: array
          description: List of primary and shared-line members assigned to the person's hot desking guest profile.
          items:
            $ref: '#/components/schemas/HotDeskingMember'
          example:
          - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ
            firstName: Alice
            lastName: Gomez
            phoneNumber: '+12055552220'
            extension: '2220'
            primaryOwner: true
            port: 1
            lineType: HOTDESKING_GUEST
            lineWeight: 1
            allowCallDeclineEnabled: true
            memberType: PEOPLE
        maxLineCount:
          type: integer
          description: Maximum number of lines that can be configured on the hot desking guest profile endpoint.
          example: 10
      example:
        model: Business Communicator - PC
        members:
        - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ
          firstName: Alice
          lastName: Gomez
          phoneNumber: '+12055552220'
          extension: '2220'
          primaryOwner: true
          port: 1
          lineType: HOTDESKING_GUEST
          lineWeight: 1
          allowCallDeclineEnabled: true
          memberType: PEOPLE
        maxLineCount: 10
    HotDeskingPutMemberType:
      type: string
      description: "Type of member in the update request. Include this field when the member ID needs an explicit resource type for decoding.\n * `USER` - The member is a person.\n * `PLACE` - The member is a workspace.\n * `VIRTUAL_PROFILE` - The member is a virtual line."
      enum:
      - USER
      - PLACE
      - VIRTUAL_PROFILE
      example: USER
    HotDeskingPutMember:
      type: object
      required:
      - id
      - port
      - primaryOwner
      - lineType
      - lineWeight
      properties:
        id:
          type: string
          description: Unique identifier for the member.
          example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ
        port:
          type: integer
          description: Port to assign to the member.
          example: 1
        primaryOwner:
          type: boolean
          description: Indicates whether this member is the hot desking guest profile owner.
          example: true
        lineType:
          $ref: '#/components/schemas/HotDeskingLineType'
        lineWeight:
          type: integer
          description: Number of lines to configure for the member on the hot desking guest profile endpoint.
          example: 1
        t38FaxCompressionEnabled:
          type: boolean
          description: T.38 fax compression setting for the member line.
          example: false
        hotlineEnabled:
          type: boolean
          description: Whether this line automatically calls a predefined number when taken off-hook.
          example: false
        hotlineDestination:
          type: string
          description: Preconfigured number for the hotline. Required when `hotlineEnabled` is `true`.
          example: '2222'
        allowCallDeclineEnabled:
          type: boolean
          description: When enabled, a call decline request is extended to all endpoints on the line. When disabled, the call is declined only at the current endpoint.
          example: true
        memberType:
          $ref: '#/components/schemas/HotDeskingPutMemberType'
    HotDeskingResponseMemberType:
      type: string
      description: "Type of assigned or available member.\n * `PEOPLE` - The member is a person.\n * `PLACE` - The member is a workspace.\n * `VIRTUAL_LINE` - The member is a virtual line."
      enum:
      - PEOPLE
      - PLACE
      - VIRTUAL_LINE
      example: PEOPLE
    HotDeskingAvailableMember:
      type: object
      required:
      - id
      - lineType
      - memberType
      properties:
        id:
          type: string
          description: Unique identifier for the available member.
          example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk
        firstName:
          type: string
          description: First name of the available member.
          example: John
        lastName:
          type: string
          description: Last name of the available member.
          example: Smith
        phoneNumber:
          type: string
          description: Phone number of the available member.
          example: '+12055552221'
        extension:
          type: string
          description: Extension of the available member.
          example: '2221'
        routingPrefix:
          type: string
          description: Routing prefix of the member's location.
          example: '1234'
        esn:
          type: string
          description: Enterprise significant number for the available member.
          example: '12342221'
        lineType:
          $ref: '#/components/schemas/HotDeskingLineType'
        memberType:
          $ref: '#/components/schemas/HotDeskingResponseMemberType'
        location:
          $ref: '#/components/schemas/Location'
    HotDeskingMember:
      type: object
      required:
      - id
      - primaryOwner
      - port
      - lineType
      - lineWeight
      - memberType
      properties:
        id:
          type: string
          description: Unique identifier for the assigned member.
          example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ
        firstName:
          type: string
          description: First name of the assigned member.
          example: Alice
        lastName:
          type: string
          description: Last name of the assigned member.
          example: Gomez
        phoneNumber:
          type: string
          description: Phone number of the assigned member.
          example: '+12055552220'
        extension:
          type: string
          description: Extension of the assigned member.
          example: '2220'
        routingPrefix:
          type: string
          description: Routing prefix of the member's location.
          example: '1234'
        esn:
          type: string
          description: Enterprise significant number for the assigned member.
          example: '12342220'
        primaryOwner:
          type: boolean
          description: Indicates whether this member is the hot desking guest profile owner.
          example: true
        port:
          type: integer
          description: Port assigned to the member.
          example: 1
        t38FaxCompressionEnabled:
          type: boolean
          description: T.38 fax compression setting for the member line.
          example: false
        lineType:
          $ref: '#/components/schemas/HotDeskingLineType'
        lineWeight:
          type: integer
          description: Number of lines configured for the member on the hot desking guest profile endpoint.
          example: 1
        hostIP:
          type: string
          description: Registration home IP address for the line port.
          example: 198.51.100.10
        remoteIP:
          type: string
          description: Registration remote IP address for the line port.
          example: 198.51.100.11
        hotlineEnabled:
          type: boolean
          description: Whether this line automatically calls a predefined number when taken off-hook.
          example: false
        hotlineDestination:
          type: string
          description: Preconfigured number for the hotline. Required when `hotlineEnabled` is `true`.
          example: '2222'
        allowCallDeclineEnabled:
          type: boolean
          description: When enabled, a call decline request is extended to all endpoints on the line. When disabled, the call is declined only at the current endpoint.
          example: true
        memberType:
          $ref: '#/components/schemas/HotDeskingResponseMemberType'
        location:
          $ref: '#/components/schemas/Location'
    HotDeskingAvailableMembers:
      type: object
      description: Response containing members that can be assigned to a person's hot desking guest profile.
      required:
      - members
      properties:
        members:
          type: array
          description: List of members that can be assigned to the person's hot desking guest profile.
          items:
            $ref: '#/components/schemas/HotDeskingAvailableMember'
          example:
          - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk
            firstName: John
            lastName: Smith
            phoneNumber: '+12055552221'
            extension: '2221'
            routingPrefix: '1234'
            esn: '12342221'
            lineType: SHARED_CALL_APPEARANCE
            memberType: PEOPLE
            location:
              id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzJiNDkyZmZkLTRjNGItNGVmNS04YzAzLWE1MDYyYzM4NDA5Mw
              name: Main Office
      example:
        members:
        - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk
          firstName: John
          lastName: Smith
          phoneNumber: '+12055552221'
          extension: '2221'
          routingPrefix: '1234'
          esn: '12342221'
          lineType: SHARED_CALL_APPEARANCE
          memberType: PEOPLE
          location:
            id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzJiNDkyZmZkLTRjNGItNGVmNS04YzAzLWE1MDYyYzM4NDA5Mw
            name: Main Office
    HotDeskingLineType:
      type: string
      description: "Line type for the hot desking guest profile member.\n * `HOTDESKING_GUEST` - Primary hot desking guest profile line.\n * `SHARED_CALL_APPEARANCE` - Shared line assigned to the hot desking guest profile.\n * `PRIMARY` - Primary line.\n * `MOBILITY` - Mobility line."
      enum:
      - HOTDESKING_GUEST
      - SHARED_CALL_APPEARANCE
      - PRIMARY
      - MOBILITY
      example: HOTDESKING_GUEST
    Location:
      type: object
      description: Location associated with the hot desking member.
      required:
      - id
      - name
      properties:
        id:
          type: string
          description: Unique identifier for the location.
          example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzJiNDkyZmZkLTRjNGItNGVmNS04YzAzLWE1MDYyYzM4NDA5Mw
        name:
          type: string
          description: Name of the location.
          example: Main Office
      example:
        id: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzJiNDkyZmZkLTRjNGItNGVmNS04YzAzLWE1MDYyYzM4NDA5Mw
        name: Main Office
    HotDeskingMembersPut:
      type: object
      description: Request body used to update the members assigned to a person's hot desking guest profile.
      required:
      - members
      properties:
        members:
          type: array
          description: Members to assign to the person's hot desking guest profile.
          items:
            $ref: '#/components/schemas/HotDeskingPutMember'
          example:
          - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ
            port: 1
            primaryOwner: true
            lineType: HOTDESKING_GUEST
            lineWeight: 1
            hotlineEnabled: false
            allowCallDeclineEnabled: true
            memberType: USER
      example:
        members:
        - id: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ
          port: 1
          primaryOwner: true
          lineType: HOTDESKING_GUEST
          lineWeight: 1
          hotlineEnabled: false
          allowCallDeclineEnabled: true
          memberType: USER
  parameters:
    phoneNumber:
      name: phoneNumber
      in: query
      description: Search for available members by phone number.
      required: false
      example: '+12055552221'
      schema:
        type: string
        minLength: 1
        maxLength: 50
    personId:
      name: personId
      in: path
      description: Unique identifier for the person.
      required: true
      example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ
      schema:
        type: string
        minLength: 1
        maxLength: 1024
    order:
      name: order
      in: query
      description: Sort order for the available member list. Multiple order values may be provided.
      required: false
      style: form
      explode: true
      example:
      - lastName-asc
      schema:
        type: array
        items:
          type: string
          minLength: 1
          maxLength: 64
          example: lastName-asc
    orgId:
      name: orgId
      in: query
      description: ID of the organization in which the person resides. Only admin users of another organization, such as partners, may use this parameter. If not specified, the organization from the OAuth token is used.
      required: false
      example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
      schema:
        type: string
        minLength: 1
        maxLength: 1024
    memberName:
      name: memberName
      in: query
      description: Search for available members by name.
      required: false
      example: John
      schema:
        type: string
        minLength: 1
        maxLength: 128
    locationId:
      name: locationId
      in: query
      description: Return only available members in this location.
      required: false
      example: Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzJiNDkyZmZkLTRjNGItNGVmNS04YzAzLWE1MDYyYzM4NDA5Mw
      schema:
        type: string
        minLength: 1
        maxLength: 1024
    start:
      name: start
      in: query
      description: Offset from the first result to fetch.
      required: false
      example: 0
      schema:
        type: integer
        default: 0
        minimum: 0
        maximum: 100000
    max:
      name: max
      in: query
      description: Maximum number of records to return.
      required: false
      example: 100
      schema:
        type: integer
        default: 2000
        minimum: 1
        maximum: 2000
    extension:
      name: extension
      in: query
      description: Search for available members by extension.
      required: false
      example: '2221'
      schema:
        type: string
        minLength: 1
        maxLength: 30
  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