Skip to main content
GET
/
device-groups
List device groups
curl --request GET \
  --url https://api.beta.ontoto.com/v1/device-groups \
  --header 'x-api-key: <api-key>'
{
  "grouped": [
    {
      "uuid": "d4e5f6a7-b8c9-40d1-e2f3-a4b5c6d7e8f9",
      "name": "Dam monitoring",
      "description": "Primary instruments",
      "sharedBy": null
    }
  ],
  "ungrouped": []
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
uuids
string[]

Filter by specific device group UUIDs

​
includeSensors
string

When true, include sensors on each device. Only applies when includeDevices=true.

​
includeDevices
string

When true, each group includes member devices in a devices array.

​
includeUngrouped
string

When true, include devices not assigned to any group in ungrouped. Only applies when includeDevices=true.

Response

Successful response

Response body for querying device groups.

​
grouped
DeviceGroup · object[]
required
​
ungrouped
DeviceItem · object[]
required