List devices
Lists the devices your integration key can reach. Every page can be
read and total_count is exact, so you can load the whole fleet.
Filter by status, or by trading with trading_id or
trading_external_ref. Find one device by its serial number with
device_identifier, or sort by -updated_at to see the most
recently changed first.
integrationKeyAuthorizationBearer <token>Your integration key, sent as Authorization: Bearer nik_<prefix>_<secret>.
Konsol issues it.
page?integer1 <= value1limit?integer1 <= value <= 10020device_identifier?stringThe device's serial number, matched exactly.
1 <= length <= 128status?string"not_activated""activated""suspended""decommissioned"trading_id?stringDevices currently assigned to this trading, as trading_ids lists them.
uuidtrading_external_ref?stringThe trading by your identifier for it, matched exactly; none matching is an empty page.
^\S(.*\S)?$1 <= length <= 128sort?stringOrders by a field, ascending, or descending with a - prefix. Ties break on
id. Without it the list is in id order.
"created_at""-created_at""updated_at""-updated_at""device_identifier""-device_identifier""status""-status""activated_at""-activated_at"A page of devices
application/json- response
data*array<>page*integer1 <= valuelimit*integer1 <= value <= 100total_count*integerExact count of matching devices.
0 <= valuetotal_is_capped*booleanAlways false.
total_pages*integer0 <= valuehas_more*booleancurl -X GET 'https://api.konsol.my/integration/v1/devices'{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "device_identifier": "string", "display_name": "string", "status": "not_activated", "activated_at": "2019-08-24T14:15:22Z", "trading_ids": [ "f974492b-bfc0-4d85-99be-88d5e8ec0ac6" ], "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "page": 1, "limit": 1, "total_count": 0, "total_is_capped": true, "total_pages": 0, "has_more": true}