Illumience API

GET /v2/devices

Returns all devices belonging to the authenticated customer.

Request

curl -k https://api.illumience.com:11443/v2/devices \
  -H "Authorization: Bearer <api_key>"

Response 200 OK

{
  "total": 2,
  "devices": [
    {
      "device_id": 4521,
      "mac": "AABBCCDDEEFF",
      "active_status": "active",
      "nickname": "Site Alpha",
      "lat": -33.918,
      "long": 18.423,
      "sw_version": "1.2.3",
      "cl_version": "4.5.6"
    },
    {
      "device_id": 4522,
      "mac": "112233445566",
      "active_status": "inactive",
      "nickname": "Site Bravo",
      "lat": null,
      "long": null,
      "sw_version": null,
      "cl_version": null
    }
  ]
}

Response Fields

FieldTypeDescription
totalintegerNumber of devices returned
devicesarrayList of device objects

Device Object:

FieldTypeDescription
device_idintegerUnique numeric device identifier
macstringDevice MAC address (no separators)
active_statusstringCurrent status (e.g. "active", "inactive")
nicknamestringUser-assigned device name
latfloatLatitude of installed location
longfloatLongitude of installed location
sw_versionstringFoundation software version
cl_versionstringCleon software version

All device fields except device_id may be null.