Skip to main content
GET
/
devices
List devices
curl --request GET \
  --url https://api.beta.ontoto.com/v1/devices \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "deviceKind": "physical",
      "serialNumber": "2CF44434E908",
      "alias": "North mine piezometer",
      "description": "Vibrating wire settlement gauge",
      "name": "NW-PZ-01",
      "orgUuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "legacyDeviceId": 10042,
      "site": {
        "uuid": "31d09506-82da-4f9d-960f-a871bae63258",
        "name": "River Dam"
      },
      "location": {
        "lat": -42.8814,
        "lon": 147.3258
      },
      "samplingPeriodSeconds": 600,
      "txPeriodSeconds": 3600,
      "state": "active",
      "health": {
        "battery": {
          "voltage": 3.72,
          "percentage": 87,
          "remaining": "56d remaining",
          "isCharging": false
        },
        "connection": {
          "lastSeen": "2024-06-15T08:42:11.000Z",
          "status": "online",
          "signalStrength": {
            "rssi": -71,
            "rsrp": -95,
            "rsrq": -12,
            "signalQuality": "good"
          },
          "error": null,
          "txProtocol": "coap",
          "nextTxTimestamp": "2024-06-15T09:42:11.000Z"
        },
        "sensors": {
          "status": "ok",
          "metadataError": null,
          "errors": null,
          "lastDataTimestamp": "2024-06-15T08:41:03.000Z"
        },
        "powerSource": "battery"
      },
      "lastTxTimestamp": "2024-06-15T08:42:11.000Z",
      "product": "Greyhound",
      "hardware": {
        "model": "GH5",
        "revision": "1.2"
      },
      "modems": [
        {
          "type": "lte",
          "model": "EG800Q",
          "imei": "861234056789012",
          "iccid": "89014103211118510720"
        }
      ],
      "firmware": {
        "string": "GH5_REV1.2_VW_1_ff",
        "version": "2.4.1"
      },
      "tags": [
        {
          "id": 12,
          "name": "Dam monitoring",
          "colour": "#1E88E5"
        }
      ],
      "queuedCommand": null,
      "gnss": null,
      "sharedBy": null
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
deviceKind

Retrieve devices by kind Physical hardware device

Allowed value: "physical"
​
groupUuid
string<uuid>

Retrieve all devices of a group

​
siteUuid
string<uuid>

Retrieve all devices assigned to a site

​
serialNumbers
string[]

Filter by array of device serial numbers

​
includeSensors
string

When true, includes sensors for each device. By default, device objects omit the sensors field.

​
includeInactiveSensors
string

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

Response

Successful response

Response body for querying devices. Schema-level example reflects list defaults (no sensors). GET /devices/:sn documents a fuller example which includes sensors.

​
items
DeviceItem · object[]
required

List of devices. Each element is a DeviceItem (see components.schemas.DeviceItem in the OpenAPI document).