Skip to main content
GET
/
devices
List devices
curl --request GET \
  --url http://localhost:8000/devices \
  --header 'X-API-KEY: <api-key>'
{
  "items": [
    {
      "serialNumber": "<string>",
      "alias": "<string>",
      "description": "<string>",
      "name": "<string>",
      "orgUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "location": {
        "lat": 123,
        "lon": 123
      },
      "samplingPeriodSeconds": 123,
      "txPeriodSeconds": 123,
      "health": {
        "battery": {
          "voltage": 123,
          "percentage": 123,
          "remaining": "<string>",
          "isCharging": true
        },
        "connection": {
          "status": "online",
          "lastSeen": "2023-11-07T05:31:56Z",
          "signalStrength": {
            "rssi": 123,
            "rsrp": 123,
            "rsrq": 123,
            "signalQuality": "no signal"
          },
          "error": {
            "code": 123,
            "message": "<string>"
          },
          "txSuccessRate": 123,
          "txProtocol": "coap",
          "nextTxTimestamp": "2023-11-07T05:31:56Z"
        },
        "sensors": {
          "status": "ok",
          "error": {
            "code": 123,
            "message": "<string>"
          },
          "lastDataTimestamp": "2023-11-07T05:31:56Z"
        },
        "powerSource": "battery"
      },
      "lastTxTimestamp": "2023-11-07T05:31:56Z",
      "product": "<string>",
      "hardware": {
        "model": "<string>",
        "revision": "<string>"
      },
      "modems": [
        {
          "type": "astrocast",
          "model": "<string>",
          "imei": "<string>",
          "iccid": "<string>",
          "uuid": "<string>"
        }
      ],
      "firmware": {
        "string": "<string>",
        "version": "<string>"
      },
      "tags": [
        {
          "id": 123,
          "name": "<string>",
          "colour": "<string>"
        }
      ],
      "_internal": {
        "peripheralId": 123,
        "metadata": "<unknown>",
        "config": "<unknown>"
      },
      "sensors": [
        {
          "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "model": "HPT604-V",
          "type": "ph",
          "physicalSensor": {
            "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "serialNumber": "<string>"
          },
          "connectionType": "integrated",
          "name": "<string>",
          "alias": "<string>",
          "deviceSerialNumber": "<string>",
          "parameters": [
            {
              "deviceSerialNumber": "<string>",
              "sensorUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "alias": "<string>",
              "name": "<string>",
              "parameterType": "temperature",
              "baseUnit": "<string>",
              "displayUnit": "<string>",
              "displayPrecision": 123,
              "suppressFaults": true,
              "sourceType": "<string>",
              "readIndex": 123,
              "deviceAlarmSupported": true,
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z",
              "parameterPath": {
                "deviceSerialNumber": "1234567890",
                "sensorName": "VibratingWire_CH1",
                "parameterName": "Frequency_CH1"
              },
              "status": "ok",
              "configErrorMessage": "<string>",
              "lastFaultSummary": {
                "reason": "null_value",
                "message": "<string>",
                "faultyPointsCount": 123,
                "totalPointsCount": 123
              },
              "lastFaultTimestamp": "2023-11-07T05:31:56Z"
            }
          ],
          "channelIndex": 123,
          "isActive": true,
          "health": {
            "status": "ok",
            "warnings": [
              "<string>"
            ],
            "errors": [
              "<string>"
            ]
          },
          "attributes": [
            {
              "behaviour": "static",
              "name": "<string>",
              "alias": "<string>",
              "valueType": "numeric",
              "value": 123,
              "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "attributeSource": "custom",
              "description": "<string>",
              "unit": "<string>",
              "function": "offset",
              "parameterType": "unknown",
              "timestamp": "2023-11-07T05:31:56Z",
              "sensorUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "physicalSensorUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "optionSet": {
                "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "name": "<string>",
                "description": "<string>",
                "orgUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "optionsType": "numeric",
                "options": [
                  {
                    "value": 123,
                    "label": "<string>"
                  }
                ],
                "allowCustomValue": true
              },
              "template": {
                "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "templateName": "<string>"
              },
              "updatedAt": "2023-11-07T05:31:56Z"
            }
          ],
          "lastActivatedAt": "2023-11-07T05:31:56Z",
          "lastDeactivatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "derivedParameters": [
        {
          "deviceSerialNumber": "<string>",
          "sensorUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "alias": "<string>",
          "name": "<string>",
          "parameterType": "temperature",
          "baseUnit": "<string>",
          "displayUnit": "<string>",
          "displayPrecision": 123,
          "suppressFaults": true,
          "sourceType": "<string>",
          "readIndex": 123,
          "deviceAlarmSupported": true,
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "parameterPath": {
            "deviceSerialNumber": "1234567890",
            "sensorName": "VibratingWire_CH1",
            "parameterName": "Frequency_CH1"
          },
          "status": "ok",
          "configErrorMessage": "<string>",
          "lastFaultSummary": {
            "reason": "null_value",
            "message": "<string>",
            "faultyPointsCount": 123,
            "totalPointsCount": 123
          },
          "lastFaultTimestamp": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ]
}

Authorizations

​
X-API-KEY
string
header
required

API key for authentication passed in the X-API-KEY header.

Example: X-API-KEY: <apiKey>

Query Parameters

​
groupUuid
string<uuid>

Retrieve all devices of a group

​
serialNumbers
string[]

Retrieve devices by serial number using an array of serial numbers

​
includeSensors
boolean

Include device sensors and derived parameters in the response

​
includeFormulas
boolean

Include the formula of any derived parameters in the response. Only applicable if includeSensors is true

​
includeInternal
boolean

Include _internal fields in the response. Subject to change.

​
includeInactiveSensors
boolean

Include sensors that are not currently active on the device firmware (for archived data)

Response

Successful response

Response body for querying devices

​
items
object[]
required