Test Environment. You are currently using the Webex for Developers test environment. Apps created here will not be available for use with Webex Teams. Please visit Webex for Developers to manage your apps.

List Devices

Lists all active Webex devices associated with the authenticated user, such as devices activated in personal mode. Administrators can list all devices within an organization.

GET/v1/devices
Query Parameters
personId
string

List devices by person ID.

placeId
string

List devices by place ID.

orgId
string

List devices in this organization. Only admin users of another organization (such as partners) may use this parameter.

displayName
string

List devices with this display name.

product
string

List devices with this product name.

Possible values: DX-80, RoomKit, SX-80
tag
string

List devices which have a tag. Accepts multiple values separated by commas.

connectionStatus
string

List devices with this connection status.

serial
string

List devices with this serial number.

software
string

List devices with this software version.

upgradeChannel
string

List devices with this upgrade channel.

errorCode
string

List devices with this error code.

capability
string

List devices with this capability.

Possible values: xapi
permission
string

List devices with this permission.

start
number

Offset. Default is 0.

max
number

Limit the maximum number of devices in the response.

Response Properties
items
array
id
string

A unique identifier for the device.

displayName
string

A friendly name for the device.

placeId
string

The place associated with the device.

personId
string

The person associated with the device.

orgId
string

The organization associated with the device.

capabilities
array

The capabilities of the device.

permissions
array

The permissions the user has for this device. For example, xapi means this user is entitled to using the xapi against this device.

connectionStatus
Device Connection Status

The connection status of the device.

product
string

The product name.

tags
array

Tags assigned to the device.

ip
string

The current IP address of the device.

activeInterface
Network Connectivty Type

The current network connectivty for the device.

mac
string

The unique address for the network adapter.

primarySipUrl
string

The primary SIP address to dial this device.

sipUrls
array

All SIP addresses to dial this device.

serial
string

Serial number for the device.

software
string

The operating system name data and version tag.

upgradeChannel
string

The upgrade channel the device is assigned to.

created
string

The date and time that the device was registered, in ISO8601 format.

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.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
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.
GET
/v1/devices{?personId,placeId,orgId,displayName,product,tag,capability,permission,connectionStatus,ip,mac,serial,activeInterface,software,upgradeChannel,sipUrl,errorCode,start,max}
Log in to try the API.
Header
Query Parameters
  • List devices by person ID.
  • List devices by place ID.
  • List devices in this organization. Only admin users of another organization (such as partners) may use this parameter.
  • List devices with this display name.
  • List devices with this product name.
  • List devices which have a tag. Accepts multiple values separated by commas.
  • List devices with this connection status.
  • List devices with this serial number.
  • 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.
  • Offset. Default is 0.
  • Limit the maximum number of devices in the response.
https://api.ciscospark.com/v1/devices?personId=Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU&placeId=Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc&orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE&displayName=SFO12-3-PanHandle&product=%5Bobject%20Object%5D,%5Bobject%20Object%5D,%5Bobject%20Object%5D&capability=%5Bobject%20Object%5D&max=100
{
  "items": [
    {
      "id": "Y2lzY29zcGFyazovL3VzL0RFVklDRVMvNTEwMUIwN0ItNEY4Ri00RUY3LUI1NjUtREIxOUM3QjcyM0Y3",
      "displayName": "SFO12-3-PanHandle",
      "placeId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU",
      "personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU",
      "orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
      "capabilities": [
        {}
      ],
      "permissions": [
        {}
      ],
      "connectionStatus": "connected",
      "product": "Cisco Webex DX80",
      "tags": [
        "First Tag",
        "Second Tag"
      ],
      "ip": "100.110.120.130",
      "activeInterface": "wired",
      "mac": "11:22:33:44:AA:FF",
      "primarySipUrl": "sample_device@sample_placename.orgname.org",
      "sipUrls": [
        "sample_device@sample_placename.orgname.org",
        "another_device@sample_placename.orgname.org"
      ],
      "serial": "FOC1923NVVN",
      "software": "RoomOS 2018-06-01 608dcdbb6e1",
      "upgradeChannel": "beta",
      "created": "2016-04-21T17:00:00.000Z"
    }
  ]
}