Create a group

curl --request POST \
  --url https://fleet-api.flatpeak.com/groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Bristol batteries",
  "filter": {
    "device_types": [
      "BATTERY_STORAGE"
    ],
    "program_id": "vpr_5c8d1f2a7b3e4d6c9a0f1b2c",
    "zone_id": "zon_9b3c5d7e1f2a4b6c8d0e2f4a",
    "max_response_seconds": 600
  }
}
'

{
  "id": "grp_2f6a9c1d8e3b5a7c4d0e9f1a",
  "object": "group",
  "live_mode": true,
  "name": "Bristol batteries",
  "filter": {
    "device_types": [
      "BATTERY_STORAGE"
    ],
    "program_id": "vpr_5c8d1f2a7b3e4d6c9a0f1b2c",
    "zone_id": "zon_9b3c5d7e1f2a4b6c8d0e2f4a",
    "min_response_seconds": null,
    "max_response_seconds": 600
  },
  "device_count": 214,
  "account_id": "acc_649d465ede6a785d2fa5f905",
  "time_created": "2026-08-12T09:30:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

POST

groups

curl --request POST \
  --url https://fleet-api.flatpeak.com/groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Bristol batteries",
  "filter": {
    "device_types": [
      "BATTERY_STORAGE"
    ],
    "program_id": "vpr_5c8d1f2a7b3e4d6c9a0f1b2c",
    "zone_id": "zon_9b3c5d7e1f2a4b6c8d0e2f4a",
    "max_response_seconds": 600
  }
}
'

{
  "id": "grp_2f6a9c1d8e3b5a7c4d0e9f1a",
  "object": "group",
  "live_mode": true,
  "name": "Bristol batteries",
  "filter": {
    "device_types": [
      "BATTERY_STORAGE"
    ],
    "program_id": "vpr_5c8d1f2a7b3e4d6c9a0f1b2c",
    "zone_id": "zon_9b3c5d7e1f2a4b6c8d0e2f4a",
    "min_response_seconds": null,
    "max_response_seconds": 600
  },
  "device_count": 214,
  "account_id": "acc_649d465ede6a785d2fa5f905",
  "time_created": "2026-08-12T09:30:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

{
  "object": "error",
  "type": "invalid_request",
  "code": "access_denied",
  "message": "The requested resource could not be found.",
  "context": "api.price_get",
  "live_mode": true,
  "time_created": "2026-01-01T00:00:00Z"
}

Authorizations

Authorization

string

header

required

Authenticate with the bearer_token obtained from the authentication endpoint.

Body

application/json

Group payload.

Group create payload. Provide exactly one of device_ids or filter.

name

string

required

Group name, for your own reference.

Example:

"Bristol batteries"

device_ids

string[]

Explicit member devices. Provide either this or filter, not both.

Example:

["dev_63a6087272941ef077a8fd3e"]

filter

object

Dynamic membership rule. Provide either this or device_ids, not both.

Show child attributes

Response

Group response.

A named collection of devices for bulk dispatch and aggregated reads. Membership is either an explicit device list or a filter that Flatpeak re-evaluates continuously. Read the members with list all group devices.

string

required

Flatpeak Group ID.

Example:

"grp_2f6a9c1d8e3b5a7c4d0e9f1a"

object

enum<string>

required

Object type, group.

Available options:

group

Example:

"group"

live_mode

boolean

required

true for live data, false for test data.

Example:

true

name

string

required

Group name, for your own reference.

Example:

"Bristol batteries"

filter

object | null

required

Dynamic membership rule. null for a group made from an explicit device list.

Show child attributes

device_count

integer

required

read-only

Current member count.

Example:

214

time_created

string<date-time>

required

Time when the object was created, in UTC.

Example:

"2026-08-12T09:30:00Z"

account_id

string

required

Flatpeak Account ID of the operator that owns the group.

Example:

"acc_649d465ede6a785d2fa5f905"

Platform

Enroll customers

Dispatch devices

Organize the fleet

Settle and reward

Authorizations

Body

Response