List Devices
Lists all active Webex devices associated with the authenticated user, such as devices activated in personal mode. This requires the spark:devices_read scope. Administrators can list all devices within their organization. This requires an administrator auth token with the spark-admin:devices_read scope.
Query Parameters
Limit the maximum number of devices in the response.
Offset. Default is 0.
List devices with this display name.
List devices by person ID.
List devices by workspace ID.
List devices in this organization. Only admin users of another organization (such as partners) may use this parameter.
List devices with this connection status.
List devices with this product name.
List devices with this type.
List devices with this serial number.
List devices which have a tag. Searching for multiple tags (logical AND) can be done by comma separating the tag values or adding several tag parameters.
List devices with this software version.
List devices with this upgrade channel.
List devices with this error code.
List devices with this capability.
List devices with this permission.
List devices by location ID.
List devices by workspace location ID. Deprecated, prefer locationId.
List devices with this MAC address.
List devices with this device platform.
Response Properties
A unique identifier for the device.
A friendly name for the device.
The placeId field has been deprecated. Please use workspaceId instead.
The workspace associated with the device.
The person associated with the device.
The organization associated with the device.
The capabilities of the device.
The permissions the user has for this device. For example, xapi means this user is entitled to using the xapi against this device.
The connection status of the device.
The product name. A display friendly version of the device's model.
The product type.
Tags assigned to the device.
The current IP address of the device.
The current network connectivty for the device.
The unique address for the network adapter.
The primary SIP address to dial this device.
All SIP addresses to dial this device.
Serial number for the device.
The operating system name data and version tag.
The upgrade channel the device is assigned to.
The date and time that the device was registered, in ISO8601 format.
The location associated with the device.
The workspace location associated with the device. Deprecated, prefer locationId.
Error codes coming from the device.
Timestamp of the first time device sent a status post.
Timestamp of the last time device sent a status post.
Entity managing the device configuration.
The device platform.
Response Codes
The list below describes the common success and error responses you should expect from the API:
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | 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 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | 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 | Gone | The requested resource is no longer available. |
| 415 | 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 | 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 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | 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 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Query Parameters
- Limit the maximum number of devices in the response.
- Offset. Default is 0.
- List devices with this display name.
- List devices by person ID.
- List devices by workspace ID.
- List devices in this organization. Only admin users of another organization (such as partners) may use this parameter.
- List devices with this connection status.
- List devices with this product name.
- List devices with this type.
- List devices with this serial number.
- List devices which have a tag. Searching for multiple tags (logical AND) can be done by comma separating the `tag` values or adding several `tag` parameters.
- List devices with this software version.
- List devices with this upgrade channel.
- List devices with this error code.
- List devices with this capability.
- List devices with this permission.
- List devices by location ID.
- List devices by workspace location ID. Deprecated, prefer `locationId`.
- List devices with this MAC address.
- List devices with this device platform.
{
"items": [
{
"id": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9ERVZJQ0UvNTEwMUIwN0ItNEY4Ri00RUY3LUI1NjUtREIxOUM3QjcyM0Y3",
"displayName": "SFO12-3-PanHandle",
"placeId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU",
"workspaceId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU",
"personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"capabilities": [
{}
],
"permissions": [
{}
],
"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"
}
]
}