APIs
XML API DeprecationGetting StartedREST API BasicsComplianceWebhooksWebex APIs
Admin
Calling
Contact Center
Devices
Meetings
Messaging
Webex Assistant Skills
FedRAMP
Full API Reference
API Changelog

Get Workspace Capabilities

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.

GET/v1/workspaces/{workspaceId}/capabilities
URI Parameters
workspaceId
stringrequired

A unique identifier for the workspace.

Response Properties
capabilities
array[Capability]

The map of workspace capabilities.

capabilityType
enum

The workspace capability name.

             + Members
                 + `occupancyDetection` - Occupancy detection.
                 + `presenceDetection` - Presence detection.
                 + `ambientNoise` - Ambient noise.
                 + `soundLevel` - Sound level.
                 + `temperature` - Temperature.
                 + `airQuality` - Air quality.
                 + `relativeHumidity` - Relative humidity.
occupancyDetection
string
capability
SupportAndConfiguredInfo
supported
boolean

Is the workspace capability supported or not.

configured
boolean

Is the workspace capability configured or not.

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe 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.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe 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.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe 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.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo 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.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
GET
/v1/workspaces//capabilities
Log in to try the API.
Header
https://webexapis.com/v1/workspaces/Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc/capabilities
200 / OK
{
  "capabilities": [
    {
      "capabilityType": "occupancyDetection",
      "capability": {
        "supported": true,
        "configured": true
      }
    }
  ]
}