GET
/
entities
/
device-groups
List Device Groups
curl --request GET \
  --url https://api.leen.dev/v1/entities/device-groups \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-CONNECTION-ID: <api-key>'
{
  "count": 123,
  "total": 123,
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "created_by": "<string>",
      "vendor_id": "<string>",
      "vendor_created_at": "2023-11-07T05:31:56Z",
      "vendor_data": {},
      "vendor": "<string>",
      "device_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    }
  ]
}

Authorizations

​
X-CONNECTION-ID
string
header
required
​
X-API-KEY
string
header
required

Query Parameters

​
enableCursor
boolean
default:false

Enable cursor based pagination instead of default offset-based pagination

​
updatedSince
string<date-time> | null

Datetime filter, only return items updated since this datetime. Example format: 2021-01-01T00:00:00+00:00

​
limit
integer
default:100

Limit size (page size)

Required range: x >= 0
​
offset
integer
default:0

Offset index (starting index of page)

Required range: x >= 0
​
excludeTotal
boolean
default:false

Skips returning the total rows, total is set to null when true

​
cursor
string | null
​
deviceId
string<uuid> | null

Device ID, pass a single device ID to get the device groups it belongs to

Response

200
application/json

Successful Response

The response is of type object.