List device groups

GET

/api/v1/device-groups

curl --request GET \
  --url 'http://localhost:3000/api/v1/device-groups?limit=20&offset=0' \
  --header 'X-API-Key: <X-API-Key>'

• Development
• Production

Paginated list of device groups with member counts, in name order. With deviceId, only the groups that device is a member of.

Authorizations

• api-key
• bearer

Parameters

Query Parameters

limit

object

offset

object

search

string

<= 100 characters

Case-insensitive substring search

deviceId

string format: uuid

Only the groups this device is a member of. 404 when the device is not a live device of the organization.

hasMembers

boolean

True: only groups with at least one live member device. false: only empty groups. Any other value is rejected with 400.

Header Parameters

x-organization-id

string format: uuid

UUID of the organization (tenant) the request acts in. It selects the tenant and grants nothing: the server checks membership or an open tenant switch. Not needed for global operations. A malformed value returns 400. API keys are fixed to their own organization; another organization returns 403. The x-organization-source header grants nothing.

Responses

200

Media typeapplication/json

object

data

required

Array<object>

object

id

required

string format: uuid

name

required

string

description

string

nullable

memberCount

required

Number of live member devices

number

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

total

required

number

hasMore

required

boolean

Example^generated

{
  "data": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "name": "example",
      "description": "example",
      "memberCount": 1,
      "createdAt": "2026-04-15T12:00:00Z",
      "updatedAt": "2026-04-15T12:00:00Z"
    }
  ],
  "total": 1,
  "hasMore": true
}

400

Invalid query

403

Forbidden — caller lacks required permission

404

DeviceId is not a live device of the organization