Skip to main content
GET
Retrieve a group

Authorizations

Authorization
string
header
required

Bearer token obtained from POST /auth/tokens.

Path Parameters

group_id
string
required

Flatpeak Group ID.

Response

Group response.

A collection of devices a VPP operator defines to scope dispatch. Read-only: you see the groups that touch your fleet, and only your own devices in them.

id
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 objects created in live mode.

Example:

true

name
string
required

Group name, as set by the VPP operator.

Example:

"Fast responders"

operator_id
string
required

Flatpeak ID of the VPP operator that defined the group.

Example:

"opr_6a3548352c0d07e89d47b7f1"

device_count
integer
required
read-only

Your devices in the group. Counts cover your account only, never other fleets.

Example:

42

time_created
string<date-time>
required

Time when the object was created, in UTC.

Example:

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

filter
object | null

The VPP operator's membership rule, where the group is dynamic. null for a group made from an explicit device list. Membership re-evaluates continuously as your devices enroll, move or change type.