Create a device group

POST

/api/v1/device-groups

curl --request POST \
  --url http://localhost:3000/api/v1/device-groups \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "name": "Plant Berlin", "description": "example" }'

• Development
• Production

Creates an empty device group. The name is unique (case-insensitive).

Authorizations

• api-key
• bearer

Parameters

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.

Request Body^required

Media typeapplication/json

object

name

required

Group name, unique among live groups of the organization (case-insensitive)

string

>= 1 characters <= 100 characters

Example

Plant Berlin

description

Free-text description

string

<= 1000 characters

Responses

201

Media typeapplication/json

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

Example^generated

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

400

Invalid body

403

Forbidden — caller lacks required permission

409

A live group with this name exists