Search devices by status

This API returns the device information for devices with status specified in the request. If no status is specified in the request, details of all the devices is returned.

HTTP Method

GET

Request URI

/msa/v1/cps/device?status=<DeviceStatus>&offset=<Integer>&limit=<Integer>

Request parameters

 

Parameter

Description

Sample Value

status

Parameter Type: Query

Data Type: String

See status.

offset

Parameter Type: Query

Data Type: Number

Default: 0

0

limit

Parameter Type: Query

Data Type: String

Default: 50

50

Response fields

A list of devices.

See List of identifiers and User.

Example response

{
   "searchResults": #List of devices,
   "results":2,
   "offset":0,
   "limit":50
}