Get Devices v1
GET {{baseUrl}}/v1/device?pagination=<integer>&applicationType=webos&search=<string>&model=<string>&maxStorageStatusPercentage=<integer>&minStorageStatusPercentage=<integer>&createdSince=<string>&createdUntil=<string>
This endoint is deprecated and will be removed in the future. Use Get Devices v2 instead.
Get all devices for current Organization.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
applicationType | string - ‘sssp’ , ‘tizen’ , ‘webos’ , ‘android’ , ‘linux’ , ‘default’ | optional | one of supported applicationTypes |
search | string | optional | search by string contained in uid, duid, name of device, serial number, MAC address or verification hash |
model | string | optional | filter by device model matching |
minStorageStatusPercentage | number 0 – 100 | optional | filter by storage usage minimal value in percentage |
maxStorageStatusPercentage | number 0 – 100 | optional | filter by storage usage maximal value in percentage |
pagination | number greater than 0 | optional | Start paginating result by a given number of items on the page. Next page link is available in the response header Link.E.g.: <https://api.signageos/v1/device?pagination=50&createdUntil=2020-10-22T16%3A10%3A00.000Z>; rel="next" |
createdSince | string | optional | filter by device createdAt greater than or equal (inclusive) date time in ISO-8601 format. |
createdUntil | string | optional | filter by device createdAt lower than (exclusive) date time in ISO-8601 format. Internally used for pagination (see pagination parameter). |
Important note
For Organizations with more than 500 devices, we strongly recommend using pagination.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
pagination | string | Start paginating result by given number items on page. Next page link is available on in response under header Link. E.g.: <https://api.signageos/v1/device?pagination=50&createdUntil=2020-10-22T16%3A10%3A00.000Z>; rel="next" | |
applicationType | string | filter by application type | |
search | string | search by string contained in uid, duid or name of device | |
model | string | filter by device model matching | |
maxStorageStatusPercentage | string | filter by storage usage maximal value in percentage | |
minStorageStatusPercentage | string | filter by storage usage minimal value in percentage | |
createdSince | string | filter by device createdAt greater than or equal (inclusive) date time in ISO-8601 format. | |
createdUntil | string | filter by device createdAt lower than (exclusive) date time in ISO-8601 format. Internally used for pagination (see pagination parameter). |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
x-auth | string | Authorization key and token | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
[]