openapi: 3.0.0 info: title: Webex Admin Address Book Workspaces API version: 1.0.0 description: The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings. These APIs enable automation of user provisioning, license assignment, compliance management, and audit event retrieval. Administrators can integrate with enterprise identity systems, enforce security policies, monitor usage, and streamline onboarding/offboarding processes. The APIs support granular control over organizational resources, making them ideal for large-scale deployments and custom admin tooling. tags: - name: Workspaces paths: /workspaces: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/WorkspaceCollectionResponse' example: items: - id: Y2lzY28zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY locationId: Y2lzY29z... workspaceLocationId: YL34GrT... floorId: Y2lzY29z... displayName: SFO-12 Capanina capacity: 5 type: notSet sipAddress: test_workspace_1@trialorg.room.ciscospark.com created: '2016-04-21T17:00:00.000Z' calling: type: hybridCalling hybridCalling: emailAddress: workspace@example.com webexCalling: licenses: - Y2lzY29g4... notes: this is a note hotdeskingStatus: 'on' supportedDevices: collaborationDevices calendar: type: microsoft emailAddress: workspace@example.com deviceHostedMeetings: enabled: true siteUrl: '''example.webex.com''' devicePlatform: cisco indoorNavigation: {} health: level: error issues: - id: '' createdAt: '' title: '' description: '' recommendedAction: '' level: Members: error devices: - id: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9ERVZJQ0UvNTEwMUIwN0ItNEY4Ri00RUY3LUI1NjUtREIxOUM3QjcyM0Y3 displayName: SFO12-3-PanHandle placeId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU workspaceId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU personId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE capabilities: - xapi permissions: - xapi:readonly connectionStatus: connected product: Cisco Webex DX80 type: roomdesk tags: - First Tag, Second Tag ip: 100.110.120.130 activeInterface: wired mac: 11:22:33:44:AA:FF primarySipUrl: sample_device@sample_workspacename.orgname.org sipUrls: - sample_device@sample_workspacename.orgname.org, another_device@sample_workspacename.orgname.org serial: FOC1923NVVN software: RoomOS 2018-06-01 608dcdbb6e1 upgradeChannel: beta created: '2016-04-21T17:00:00.000Z' locationId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE workspaceLocationId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE errorCodes: - sipprofileregistration firstSeen: '2021-02-24T09:08:38.822Z' lastSeen: '2023-08-15T14:04:00.444Z' managedBy: CISCO devicePlatform: cisco capabilities: occupancyDetection: supported: true configured: true presenceDetection: supported: true configured: true ambientNoise: supported: true configured: true soundLevel: supported: true configured: true temperature: supported: true configured: true airQuality: supported: true configured: true relativeHumidity: supported: true configured: true plannedMaintenance: mode: upcoming startTime: '2026-10-01T00:00:00.000Z' endTime: '2026-10-02T00:00:00.000Z' description: Scheduled maintenance for the workspace. customAttributes: myKey: value: '123456789' type: external_id '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 Workspaces operationId: listWorkspaces description: 'List workspaces. Use query parameters to filter the response. The `orgId` parameter can only be used by admin users of another organization (such as partners). The `locationId`, `workspaceLocationId`, `indoorNavigation`, `floorId`, `capacity` and `type` fields will only be present for workspaces that have a value set for them. The special values `notSet` (for filtering on category) and `-1` (for filtering on capacity) can be used to filter for workspaces without a type and/or capacity.' tags: - Workspaces parameters: - name: orgId in: query description: List workspaces in this organization. Only admin users of another organization (such as partners) may use this parameter. example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE schema: type: string - name: locationId in: query description: Location associated with the workspace. Values must originate from the /locations API and not the legacy /workspaceLocations API. example: YL34GrT... schema: type: string - name: workspaceLocationId in: query description: Location associated with the workspace. Both values from the /locations API and the legacy /workspaceLocations API are supported. This field is deprecated and integrations should prefer `locationId` going forward. example: YL34GrT... schema: type: string - name: floorId in: query description: Floor associated with the workspace. example: Y2lzY29z... schema: type: string - name: displayName in: query description: List workspaces by display name. example: SFO-12 Capanina schema: type: string - name: capacity in: query description: List workspaces with the given capacity. Must be -1 or higher. A value of -1 lists workspaces with no capacity set. example: 5 schema: type: number - name: type in: query description: List workspaces by type. example: focus schema: type: string enum: - notSet - focus - huddle - meetingRoom - open - desk - other - name: start in: query description: Offset. Default is 0. example: 50 schema: type: number - name: max in: query description: Limit the maximum number of workspaces in the response. example: 100 schema: type: number - name: calling in: query description: List workspaces by calling type. example: freeCalling schema: type: string enum: - freeCalling - hybridCalling - webexCalling - webexEdgeForDevices - thirdPartySipCalling - none - name: supportedDevices in: query description: List workspaces by supported devices. example: collaborationDevices schema: type: string enum: - collaborationDevices - phones - name: calendar in: query description: List workspaces by calendar type. example: none schema: type: string enum: - none - google - microsoft - name: deviceHostedMeetingsEnabled in: query description: List workspaces enabled for device hosted meetings. example: true schema: type: boolean - name: devicePlatform in: query description: List workspaces by device platform. example: cisco schema: type: string enum: - cisco - microsoftTeamsRoom - name: healthLevel in: query description: List workspaces by health level. example: error schema: type: string enum: - error - warning - info - ok - name: includeDevices in: query description: Flag identifying whether to include the devices associated with the workspace in the response. example: false schema: type: boolean - name: includeCapabilities in: query description: Flag identifying whether to include the workspace capabilities in the response. example: false schema: type: boolean - name: plannedMaintenance in: query description: List workspaces with given maintenance mode. example: 'off' schema: type: string enum: - 'off' - 'on' - upcoming - name: customAttribute in: query description: List workspaces with given custom attribute key. example: myKey schema: type: string post: responses: '201': description: Created headers: {} content: application/json: schema: $ref: '#/components/schemas/Workspace' example: id: Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY locationId: YL34GrT... workspaceLocationId: YL34GrT... floorId: Y2lzY29z... displayName: SFO-12 Capanina capacity: 5 sipAddress: test_workspace_1@trialorg.room.ciscospark.com created: '2016-04-21T17:00:00.000Z' calling: type: webexCalling webexCalling: licenses: - Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvMmQzMzIyZDItYTAzNS00YmEzLWI3ZjYtNDc1ODM3Y2UzOTVhOkJDQ0FfNDZlM2YxYWQtZGJhYi00YmQ0LTg3YTAtOWExZmVhNzMxN2Jm calendar: type: microsoft emailAddress: workspace@example.com notes: this is a note supportedDevices: collaborationDevices indoorNavigation: url: https://example.com '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: Create a Workspace operationId: createWorkspace description: 'Create a workspace. The `locationId`, `workspaceLocationId`, `floorId`, `indoorNavigation`, `capacity`, `type`, `notes` and `hotdeskingStatus` parameters are optional, and omitting them will result in the creation of a workspace without these values set, or set to their default. A `locationId` must be provided when the `floorId` is set. Calendar and calling can also be set for a new workspace. Omitting them will default to free calling and no calendaring. The `orgId` parameter can only be used by admin users of another organization (such as partners). * Information for Webex Calling fields may be found here: [locations](/docs/api/v1/locations/list-locations), [available numbers](/docs/api/v1/numbers/get-phone-numbers-for-an-organization-with-given-criterias) and [licenses](/docs/api/v1/licenses). * The `locationId` and `supportedDevices` fields cannot be changed once configured. * When creating a `webexCalling` workspace that is not hot desk only, a `locationId` and either a `phoneNumber` or `extension` or both is required. Furthermore, it is possible to set the `licenses` field with a list of Webex Calling license IDs, if desired. If multiple license IDs are provided, the oldest suitable one will be applied. If no licenses are supplied, the oldest suitable one from the active subscriptions will be automaticaly applied. * When creating a hot desk only workspace, `phoneNumber` and `extension` fields are not applicable. Furthermore, `deviceHostedMeetingsEnabled`, and `calendar` services are not applicable. If any of these fields are provided the API will return an error. The `calling` type is `webexCalling`.' tags: - Workspaces parameters: [] requestBody: content: application/json: example: displayName: SFO-12 Capanina orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY locationId: YL34GrT... workspaceLocationId: YL34GrT... floorId: Y2lzY29z... capacity: 5 type: notSet calling: type: webexCalling webexCalling: phoneNumber: '+12145654032' extension: '28278' locationId: Y2lzY29g4... licenses: - Y2lzY29g4...1,Y2lzY29g4...2,Y2lzY29g4...n calendar: type: microsoft emailAddress: workspace@example.com resourceGroupId: Y2lzY29zcGFyazovL3VybjpURUFNOk5vcndheS9SRVNPVVJDRV9HUk9VUC9jOGFiMDJhNC01NjI5LTRiNTctOGUyNy03ZDZkZjJlN2YzNzA= notes: this is a note hotdeskingStatus: 'on' deviceHostedMeetings: enabled: true siteUrl: '''example.webex.com''' supportedDevices: collaborationDevices indoorNavigation: {} schema: $ref: '#/components/schemas/WorkspaceCreationRequest' /workspaces/{workspaceId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/Workspace' example: id: Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY locationId: Y2lzY29... workspaceLocationId: YL34GrT... floorId: Y2lzY29z... displayName: SFO-12 Capanina capacity: 5 type: notSet sipAddress: test_workspace_1@trialorg.room.ciscospark.com created: '2016-04-21T17:00:00.000Z' calling: type: hybridCalling hybridCalling: emailAddress: workspace@example.com webexCalling: licenses: - Y2lzY29g4... notes: this is a note hotdeskingStatus: 'on' supportedDevices: collaborationDevices calendar: type: microsoft emailAddress: workspace@example.com deviceHostedMeetings: enabled: true siteUrl: '''example.webex.com''' devicePlatform: cisco indoorNavigation: {} health: level: error issues: - id: '' createdAt: '' title: '' description: '' recommendedAction: '' level: Members: error devices: - id: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9ERVZJQ0UvNTEwMUIwN0ItNEY4Ri00RUY3LUI1NjUtREIxOUM3QjcyM0Y3 displayName: SFO12-3-PanHandle placeId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU workspaceId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU personId: Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE capabilities: - xapi permissions: - xapi:readonly connectionStatus: connected product: Cisco Webex DX80 type: roomdesk tags: - First Tag, Second Tag ip: 100.110.120.130 activeInterface: wired mac: 11:22:33:44:AA:FF primarySipUrl: sample_device@sample_workspacename.orgname.org sipUrls: - sample_device@sample_workspacename.orgname.org, another_device@sample_workspacename.orgname.org serial: FOC1923NVVN software: RoomOS 2018-06-01 608dcdbb6e1 upgradeChannel: beta created: '2016-04-21T17:00:00.000Z' locationId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE workspaceLocationId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE errorCodes: - sipprofileregistration firstSeen: '2021-02-24T09:08:38.822Z' lastSeen: '2023-08-15T14:04:00.444Z' managedBy: CISCO devicePlatform: cisco capabilities: occupancyDetection: supported: true configured: true presenceDetection: supported: true configured: true ambientNoise: supported: true configured: true soundLevel: supported: true configured: true temperature: supported: true configured: true airQuality: supported: true configured: true relativeHumidity: supported: true configured: true '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: Get Workspace Details operationId: getWorkspaceDetails description: 'Shows details for a workspace, by ID. The `locationId`, `workspaceLocationId`, `floorId`, `indoorNavigation`, `capacity`, `type` and `notes` fields will only be present if they have been set for the workspace. Specify the workspace ID in the `workspaceId` parameter in the URI.' tags: - Workspaces parameters: - name: workspaceId in: path description: A unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc schema: type: string - name: includeDevices in: query description: Flag identifying whether to include the devices associated with the workspace in the response. example: false schema: type: boolean - name: includeCapabilities in: query description: Flag identifying whether to include the workspace capabilities in the response. example: false schema: type: boolean put: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/Workspace' example: id: Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY locationId: YL34GrT... workspaceLocationId: YL34GrT... floorId: Y2lzY29z... displayName: SFO-12 Capanina capacity: 5 sipAddress: test_workspace_1@trialorg.room.ciscospark.com created: '2016-04-21T17:00:00.000Z' calling: type: webexCalling webexCalling: licenses: - Y2lzY29z... calendar: type: microsoft emailAddress: workspace@example.com notes: this is a note supportedDevices: collaborationDevices devicePlatform: cisco indoorNavigation: url: https://example.com '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: Update a Workspace operationId: updateWorkspace description: 'Updates details for a workspace by ID. Specify the workspace ID in the `workspaceId` parameter in the URI. Include all details for the workspace that are present in a [GET request for the workspace details](/docs/api/v1/workspaces/get-workspace-details). Not including the optional `capacity`, `type` or `notes` fields will result in the fields no longer being defined for the workspace. A `locationId` must be provided when the `floorId` is set. The `locationId`, `workspaceLocationId`, `floorId`, `supportedDevices`, `calendar` and `calling` fields do not change when omitted from the update request. * Information for Webex Calling fields may be found here: [locations](/docs/api/v1/locations/list-locations) and [available numbers](/docs/api/v1/numbers/get-phone-numbers-for-an-organization-with-given-criterias). * Updating the `calling` parameter is only supported if the existing `calling` type is `freeCalling`, `none`, `thirdPartySipCalling` or `webexCalling`. * Updating the `calling` parameter to `none`, `thirdPartySipCalling` or `webexCalling` is not supported if the workspace contains any devices. * The `locationId` and `supportedDevices` fields cannot be changed once configured. * When updating `webexCalling` information on a workspace that is not hot desk only, a `locationId` and either a `phoneNumber` or `extension` or both is required. Furthermore, the `licenses` field can be set with a list of Webex Calling license IDs, if desired. If multiple license IDs are provided, the oldest suitable one will be applied. If a previously applied license ID is omitted, it will be replaced with one from the list provided. If the `licenses` field is omitted, the current calling license will be retained. * When specifying a hot desk only license on a hot desk only workspace, `deviceHostedMeetingsEnabled`, and `calendar` services are not supported and will be automatically disabled. In addition to this, the `phoneNumber` and `extension` will be removed from the workspace. Attempting to enable any of these services, or provide a `phoneNumber` or `extension` will result in an error. The `calling` type for these requests is `webexCalling`.' tags: - Workspaces parameters: - name: workspaceId in: path description: A unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc schema: type: string requestBody: content: application/json: example: displayName: SFO-12 Capanina locationId: YL34GrT... workspaceLocationId: YL34GrT... floorId: Y2lzY29z... capacity: 5 type: focus calendar: type: microsoft emailAddress: workspace@example.com resourceGroupId: Y2lzY29zcGFyazovL3VybjpURUFNOk5vcndheS9SRVNPVVJDRV9HUk9VUC9jOGFiMDJhNC01NjI5LTRiNTctOGUyNy03ZDZkZjJlN2YzNzA= calling: type: webexCalling webexCalling: phoneNumber: '+12145654032' extension: '28278' locationId: Y2lzY29g4... licenses: - Y2lzY29g4...1,Y2lzY29g4...2,Y2lzY29g4...n notes: this is a note hotdeskingStatus: 'on' deviceHostedMeetings: enabled: true siteUrl: '''example.webex.com''' indoorNavigation: {} schema: $ref: '#/components/schemas/WorkspaceUpdateRequest' 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 a Workspace operationId: deleteWorkspace description: 'Deletes a workspace by ID. Also deletes all devices associated with the workspace. Any deleted devices will need to be reactivated. Specify the workspace ID in the `workspaceId` parameter in the URI.' tags: - Workspaces parameters: - name: workspaceId in: path description: A unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc schema: type: string /workspaces/{workspaceId}/capabilities: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/CapabilityResponse' example: capabilities: occupancyDetection: supported: true configured: true presenceDetection: supported: true configured: true ambientNoise: supported: true configured: true soundLevel: supported: true configured: true temperature: supported: true configured: true airQuality: supported: true configured: true relativeHumidity: supported: true configured: true '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: Get Workspace Capabilities operationId: getWorkspaceCapabilities description: 'Shows the capabilities for a workspace by ID. Returns a set of capabilities, including whether or not the capability is supported by any device in the workspace, and if the capability is configured (enabled). For example for a specific capability like `occupancyDetection`, the API will return if the capability is supported and/or configured such that occupancy detection data will flow from the workspace (device) to the cloud. Specify the workspace ID in the `workspaceId` parameter in the URI.' tags: - Workspaces parameters: - name: workspaceId in: path description: A unique identifier for the workspace. required: true example: Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc schema: type: string components: schemas: DevicePlatform: type: string enum: - cisco - microsoftTeamsRoom description: Device platform example: cisco WorkspaceUpdateRequest: type: object properties: displayName: type: string example: SFO-12 Capanina description: A friendly name for the workspace. locationId: type: string example: YL34GrT... description: Location associated with the workspace. Must be provided when the `floorId` is set. workspaceLocationId: type: string example: YL34GrT... description: Legacy workspace location ID associated with the workspace. Prefer `locationId`. floorId: type: string example: Y2lzY29z... description: Floor associated with the workspace. capacity: type: number example: 5 description: How many people the workspace is suitable for. If set, must be 0 or higher. type: type: string enum: - notSet - focus - huddle - meetingRoom - open - desk - other description: "The type that best describes the workspace.\n * `notSet` - No workspace type set.\n * `focus` - High concentration.\n * `huddle` - Brainstorm/collaboration.\n * `meetingRoom` - Dedicated meeting space.\n * `open` - Unstructured agile.\n * `desk` - Individual.\n * `other` - Unspecified.\n" calendar: type: object properties: type: type: string example: microsoft emailAddress: type: string example: workspace@example.com description: Workspace email address. Will not be set when the calendar type is `none`. resourceGroupId: type: string example: Y2lzY29zcGFyazovL3VybjpURUFNOk5vcndheS9SRVNPVVJDRV9HUk9VUC9jOGFiMDJhNC01NjI5LTRiNTctOGUyNy03ZDZkZjJlN2YzNzA= description: The `ResourceGroup` ID is associated with the workspace and is only applicable for on-premise MICROSOFT calendar. description: An empty or null `calendar` field will not cause any changes. Provide a `type` (`microsoft`, `google`, or `none`), an `emailAddress`, and a `resourceGroupId`. To remove a calendar, set the `type` to `none`; this does not require an `emailAddress` or `resourceGroupId`. sipAddress: type: string description: The `sipAddress` field can only be provided when calling type is `thirdPartySipCalling`. calling: type: object properties: type: type: string enum: - freeCalling - hybridCalling - webexCalling - webexEdgeForDevices - thirdPartySipCalling - none description: "The calling type that is supported on the workspace.\n * `freeCalling` - Free Calling (Default).\n * `hybridCalling` - Hybrid Calling.\n * `webexCalling` - Webex Calling.\n * `webexEdgeForDevices` - Webex Edge For Devices.\n * `thirdPartySipCalling` - Third-party SIP URI.\n * `none` - No Calling.\n" webexCalling: type: object properties: phoneNumber: type: string example: '+12145654032' description: End user phone number. extension: type: string example: '28278' description: End user extension. locationId: type: string example: Y2lzY29g4... description: Calling location ID. licenses: type: array items: type: string example: Y2lzY29g4...1,Y2lzY29g4...2,Y2lzY29g4...n description: A list of Webex Calling license IDs. If multiple license IDs are provided, the oldest suitable one will be applied. description: The `webexCalling` object only applies when calling type is `webexCalling`. description: Calling types supported on update are `freeCalling`, `thirdPartySipCalling`, `webexCalling` and `none`. notes: type: string example: this is a note description: Notes associated to the workspace. hotdeskingStatus: type: string enum: - 'on' - 'off' description: "Hot desking status of the workspace.\n * `on` - Workspace supports hotdesking.\n * `off` - Workspace does not support hotdesking.\n" deviceHostedMeetings: type: object properties: enabled: type: boolean example: true description: Set to `true` to enable or `false` to disable. siteUrl: type: string example: '''example.webex.com''' description: The Webex site for device hosting meetings. description: To enable device hosted meetings, set a Webex `siteUrl` and the `enabled` flag to `true`. indoorNavigation: type: object properties: url: type: string description: URL of a map locating the workspace. Passing `null` will remove the configuration. description: Indoor navigation configuration. WorkspaceIssue: type: object properties: id: type: string description: Issue id. createdAt: type: string description: Issue created timestamp. title: type: string description: Issue title. description: type: string description: Issue description. recommendedAction: type: string description: Recommended action to mitigate issue. level: type: object properties: Members: type: string enum: - error - warning - info description: Issue level. WorkspaceCollectionResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/Workspace' description: An array of workspace objects. example: items: [] CapabilityResponse: type: object example: capabilities: occupancyDetection: supported: true configured: true presenceDetection: supported: true configured: true ambientNoise: supported: true configured: true soundLevel: supported: true configured: true temperature: supported: true configured: true airQuality: supported: true configured: true relativeHumidity: supported: true configured: true properties: capabilities: $ref: '#/components/schemas/CapabilityMap' NetworkConnectivityType: type: string enum: - wired description: The current network connectivity for the device. example: wired DeviceConnectionStatus: type: string enum: - connected - disconnected - connected_with_issues - offline_expired - activating - unknown - offline_deep_sleep description: The connection status of the device. example: connected SupportAndConfiguredInfo: type: object properties: supported: type: boolean example: true description: Is the workspace capability supported or not. configured: type: boolean example: true description: Is the workspace capability configured or not. description: Support and configured information for a workspace capability. example: supported: true configured: true Device: type: object required: - created properties: id: type: string example: Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9ERVZJQ0UvNTEwMUIwN0ItNEY4Ri00RUY3LUI1NjUtREIxOUM3QjcyM0Y3 description: A unique identifier for the device. displayName: type: string example: SFO12-3-PanHandle description: A friendly name for the device. placeId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU description: The `placeId` field has been deprecated. Please use `workspaceId` instead. workspaceId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU description: The workspace associated with the device. personId: type: string example: Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU description: The person associated with the device. orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE description: The organization associated with the device. capabilities: type: array items: $ref: '#/components/schemas/DeviceCapabilities' description: The capabilities of the device. example: - xapi permissions: type: array items: $ref: '#/components/schemas/DevicePermissions' description: The permissions the user has for this device. For example, `xapi` means this user is entitled to using the `xapi` against this device. example: - xapi:readonly - xapi:all connectionStatus: $ref: '#/components/schemas/DeviceConnectionStatus' product: type: string example: Cisco Webex DX80 description: The product name. A display friendly version of the device's `model`. type: type: string example: roomdesk description: The product type. tags: type: array items: type: string example: First Tag, Second Tag description: Tags assigned to the device. example: - First Tag - Second Tag ip: type: string example: 100.110.120.130 description: The current IP address of the device. activeInterface: $ref: '#/components/schemas/NetworkConnectivityType' mac: type: string example: 11:22:33:44:AA:FF description: The unique address for the network adapter. primarySipUrl: type: string example: sample_device@sample_workspacename.orgname.org description: The primary SIP address to dial this device. sipUrls: example: - sample_device@sample_workspacename.orgname.org - another_device@sample_workspacename.orgname.org type: array items: type: string example: sample_device@sample_workspacename.orgname.org, another_device@sample_workspacename.orgname.org description: All SIP addresses to dial this device. serial: type: string example: FOC1923NVVN description: Serial number for the device. software: type: string example: RoomOS 2018-06-01 608dcdbb6e1 description: The operating system name data and version tag. upgradeChannel: type: string example: beta description: The upgrade channel the device is assigned to. created: type: string example: '2016-04-21T17:00:00.000Z' description: The date and time that the device was registered, in ISO8601 format. locationId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE description: The location associated with the device. workspaceLocationId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE description: The workspace location associated with the device. Deprecated, prefer `locationId`. errorCodes: example: - sipprofileregistration type: array items: type: string example: sipprofileregistration description: Error codes coming from the device. firstSeen: type: string example: '2021-02-24T09:08:38.822Z' description: Timestamp of the first time device sent a status post. lastSeen: type: string example: '2023-08-15T14:04:00.444Z' description: Timestamp of the last time device sent a status post. managedBy: $ref: '#/components/schemas/ManagedBy' devicePlatform: $ref: '#/components/schemas/DevicePlatform' plannedMaintenance: type: object description: The planned maintenance for the device. properties: mode: type: string enum: - 'off' - 'on' - upcoming description: The planned maintenance mode for the device DeviceCapabilities: type: string enum: - xapi DevicePermissions: type: string enum: - xapi:readonly - xapi:all CapabilityMap: type: object description: The map of workspace capabilities. example: occupancyDetection: supported: true configured: true presenceDetection: supported: true configured: true ambientNoise: supported: true configured: true soundLevel: supported: true configured: true temperature: supported: true configured: true airQuality: supported: true configured: true relativeHumidity: supported: true configured: true properties: occupancyDetection: $ref: '#/components/schemas/SupportAndConfiguredInfo' presenceDetection: $ref: '#/components/schemas/SupportAndConfiguredInfo' ambientNoise: $ref: '#/components/schemas/SupportAndConfiguredInfo' soundLevel: $ref: '#/components/schemas/SupportAndConfiguredInfo' temperature: $ref: '#/components/schemas/SupportAndConfiguredInfo' airQuality: $ref: '#/components/schemas/SupportAndConfiguredInfo' relativeHumidity: $ref: '#/components/schemas/SupportAndConfiguredInfo' WorkspaceCreationRequest: type: object required: - displayName properties: displayName: type: string example: SFO-12 Capanina description: A friendly name for the workspace. orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY description: '`OrgId` associated with the workspace. Only admin users of another organization (such as partners) may use this parameter.' locationId: type: string example: YL34GrT... description: Location associated with the workspace. Must be provided when the `floorId` is set. workspaceLocationId: type: string example: YL34GrT... description: Legacy workspace location ID associated with the workspace. Prefer `locationId`. floorId: type: string example: Y2lzY29z... description: Floor associated with the workspace. capacity: type: number example: 5 description: How many people the workspace is suitable for. If set, must be 0 or higher. type: type: string enum: - notSet - focus - huddle - meetingRoom - open - desk - other description: "The type that best describes the workspace.\n * `notSet` - No workspace type set.\n * `focus` - High concentration.\n * `huddle` - Brainstorm/collaboration.\n * `meetingRoom` - Dedicated meeting space.\n * `open` - Unstructured agile.\n * `desk` - Individual.\n * `other` - Unspecified.\n" sipAddress: type: string description: The `sipAddress` field can only be provided when calling type is `thirdPartySipCalling`. calling: type: object properties: type: type: string enum: - freeCalling - hybridCalling - webexCalling - webexEdgeForDevices - thirdPartySipCalling - none description: "The calling type that is supported on the workspace.\n * `freeCalling` - Free Calling (Default).\n * `hybridCalling` - Hybrid Calling.\n * `webexCalling` - Webex Calling.\n * `webexEdgeForDevices` - Webex Edge For Devices.\n * `thirdPartySipCalling` - Third-party SIP URI.\n * `none` - No Calling.\n" webexCalling: type: object properties: phoneNumber: type: string example: '+12145654032' description: End user phone number. extension: type: string example: '28278' description: End user extension. locationId: type: string example: Y2lzY29g4... description: Calling location ID. licenses: type: array items: type: string example: Y2lzY29g4...1,Y2lzY29g4...2,Y2lzY29g4...n description: A list of Webex Calling License IDs. If multiple license IDs are provided, the oldest suitable one will be applied. description: The `webexCalling` object only applies when calling type is `webexCalling`. description: Calling. calendar: type: object properties: type: type: string example: microsoft emailAddress: type: string example: workspace@example.com description: Workspace email address. Will not be set when the calendar type is `none`. resourceGroupId: type: string example: Y2lzY29zcGFyazovL3VybjpURUFNOk5vcndheS9SRVNPVVJDRV9HUk9VUC9jOGFiMDJhNC01NjI5LTRiNTctOGUyNy03ZDZkZjJlN2YzNzA= description: The `ResourceGroup` ID is associated with the workspace and is only applicable for on-premise MICROSOFT calendar. description: Workspace calendar configuration requires a `type` (`microsoft`, `google`, or `none`), an `emailAddress`, and a `resourceGroupId`. The default is `none`. notes: type: string example: this is a note description: Notes associated to the workspace. hotdeskingStatus: type: string enum: - 'on' - 'off' description: "Hot desking status of the workspace.\n * `on` - Workspace supports hotdesking.\n * `off` - Workspace does not support hotdesking.\n" deviceHostedMeetings: type: object properties: enabled: type: boolean example: true description: Set to `true` to enable or `false` to disable. siteUrl: type: string example: '''example.webex.com''' description: The Webex site for device hosting meetings. description: To enable device hosted meetings, set a Webex `siteUrl` and the `enabled` flag to `true`. supportedDevices: type: string enum: - collaborationDevices - phones description: "The supported devices for the workspace. Default is `collaborationDevices`.\n * `collaborationDevices` - Workspace supports collaboration devices.\n * `phones` - Workspace supports MPP phones.\n" indoorNavigation: type: object properties: url: type: string description: URL of a map locating the workspace. description: Indoor navigation configuration. Workspace: type: object properties: id: type: string example: Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc description: Unique identifier for the Workspace. orgId: type: string example: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY description: '`OrgId` associated with the workspace.' locationId: type: string example: Y2lzY29... description: Location associated with the workspace (ID to use for the [/locations API](/docs/api/v1/locations)). workspaceLocationId: type: string example: YL34GrT... description: Legacy workspace location ID associated with the workspace. Prefer `locationId`. floorId: type: string example: Y2lzY29z... description: Floor associated with the workspace. displayName: type: string example: SFO-12 Capanina description: A friendly name for the workspace. capacity: type: number example: 5 description: How many people the workspace is suitable for. type: type: string enum: - notSet - focus - huddle - meetingRoom - open - desk - other description: "The workspace type.\n * `notSet` - No workspace type set.\n * `focus` - High concentration.\n * `huddle` - Brainstorm/collaboration.\n * `meetingRoom` - Dedicated meeting space.\n * `open` - Unstructured agile.\n * `desk` - Individual.\n * `other` - Unspecified.\n" sipAddress: type: string example: test_workspace_1@trialorg.room.ciscospark.com description: '`SipUrl` to call all the devices associated with the workspace.' created: type: string example: '2016-04-21T17:00:00.000Z' description: The date and time that the workspace was registered, in ISO8601 format. calling: type: object properties: type: type: string enum: - freeCalling - hybridCalling - webexCalling - webexEdgeForDevices - thirdPartySipCalling - none description: "Calling.\n * `freeCalling` - Free Calling.\n * `hybridCalling` - Hybrid Calling.\n * `webexCalling` - Webex Calling.\n * `webexEdgeForDevices` - Webex Edge For Devices.\n * `thirdPartySipCalling` - Third-party SIP URI.\n * `none` - No Calling.\n" hybridCalling: type: object properties: emailAddress: type: string example: workspace@example.com description: End user email address in Cisco Unified CM. description: The `hybridCalling` object only applies when calling type is `hybridCalling`. webexCalling: type: object properties: licenses: type: array items: type: string example: Y2lzY29g4... description: The Webex Calling license associated with this workspace. description: The `webexCalling` object only applies when calling type is `webexCalling`. description: Calling type. calendar: type: object properties: type: type: string enum: - none - google - microsoft description: " * `none` - No calendar.\n * `google` - Google Calendar.\n * `microsoft` - Microsoft Exchange or Office 365.\n" emailAddress: type: string example: workspace@example.com description: Workspace email address. Will not be set when the calendar type is `none`. description: Calendar type. Calendar of type `none` does not include an `emailAddress` field. notes: type: string example: this is a note description: Notes associated to the workspace. hotdeskingStatus: type: string enum: - 'on' - 'off' description: "Hot desking status of the workspace.\n * `on` - Workspace supports hotdesking.\n * `off` - Workspace does not support hotdesking.\n" supportedDevices: type: string enum: - collaborationDevices - phones description: "The supported devices for the workspace. Default is `collaborationDevices`.\n * `collaborationDevices` - Workspace supports collaboration devices.\n * `phones` - Workspace supports MPP phones.\n" deviceHostedMeetings: type: object properties: enabled: type: boolean example: true description: '`true` if enabled or `false` otherwise.' siteUrl: type: string example: '''example.webex.com''' description: The Webex site for the device hosting meetings. description: Device hosted meetings configuration. devicePlatform: type: string enum: - cisco - microsoftTeamsRoom description: "The device platform.\n * `cisco` - Cisco.\n * `microsoftTeamsRoom` - Microsoft Teams Room.\n" indoorNavigation: type: object properties: url: type: string description: URL of a map locating the workspace. description: Indoor navigation configuration. health: type: object properties: level: type: string enum: - error - warning - info - ok description: Health level. The level is based on the list of issues associated with the workspace. issues: type: array items: $ref: '#/components/schemas/WorkspaceIssue' description: A list of workspace issues. description: The health of the workspace. devices: type: array items: $ref: '#/components/schemas/Device' description: A list of devices associated with the workspace. capabilities: type: array items: $ref: '#/components/schemas/CapabilityMap' description: The map of workspace capabilities. plannedMaintenance: type: object description: The planned maintenance for the workspace. properties: mode: type: string enum: - 'off' - 'on' - upcoming description: The planned maintenance mode for the workspace startTime: type: string example: '2026-10-01T00:00:00.000Z' description: The start of the planned maintenance period. endTime: type: string example: '2026-10-02T00:00:00.000Z' description: The end of the planned maintenance period. example: id: Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc orgId: Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY locationId: YL34GrT... workspaceLocationId: YL34GrT... floorId: Y2lzY29z... displayName: SFO-12 Capanina capacity: 5 sipAddress: '' ManagedBy: type: string enum: - CISCO - CUSTOMER - PARTNER description: Entity managing the device configuration. example: CISCO 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: oauth2 description: OAuth 2.0 Bearer token authentication flows: authorizationCode: authorizationUrl: https://webexapis.com/v1/authorize tokenUrl: https://webexapis.com/v1/access_token scopes: spark:applications_token: Create access tokens for Service Apps