> ## Documentation Index > Fetch the complete documentation index at: /docs/llms.txt > Use this file to discover all available pages before exploring further. # Create a group > Creates a group with exactly one of `device_ids` (explicit) or `filter` (dynamic). Filter groups re-evaluate membership continuously. ## OpenAPI ````yaml fleet-api/reference/flatpeak-api-spec-fleet.json POST /groups openapi: 3.0.3 info: description: >- The Flatpeak Fleet API. VPP operators use it to enroll, dispatch and settle OEM device fleets. ## Authentication Exchange your `account_id` and `secret_key` for a bearer token at `POST /auth/tokens` with basic auth. Send it as `Authorization: Bearer ` on every request. ## Base URL `https://fleet-api.flatpeak.com` ## Pagination Lists return `data`, `next_cursor` and `url`. Pass `next_cursor` as `cursor` until it is `null`. A cursor is opaque and bound to the endpoint and query parameters that issued it. ## Errors Every non-2xx response carries `object`, `type`, `code` and `message`. Branch on `code`. ## Money and energy Money is a decimal number paired with a `currency_code` (ISO 4217). Power is in kW and energy in kWh. Positive is import, negative is export. ## Live and test `live_mode` marks live or test data. version: 2027-01-01.busbar title: Flatpeak Fleet API termsOfService: https://flatpeak.com/legal contact: name: Technical Support email: support@flatpeak.com url: https://flatpeak.com/contact license: name: Apache 2.0 url: https://flatpeak.com/legal servers: - url: https://fleet-api.flatpeak.com security: - bearerAuth: [] tags: - name: Authentication description: >- Exchange your account credentials for a bearer token to authenticate API requests. - name: Connect description: >- Create and retrieve Connect sessions for onboarding customers through your own app. - name: OEMs description: List and retrieve the OEMs whose devices your fleet can reach. - name: Devices description: >- Retrieve, list and update the devices connected to your account, and read their consent history and shared settings. - name: Locations description: >- Read the location a device sits behind: its timezone, currency, metering and your devices there. - name: Dispatch description: Submit plans to devices on managed tariffs and read the dispatch timeline. - name: Telemetry description: Read device state, device meter records and location meter records. - name: Tariffs description: Create, retrieve, delete, and list tariffs. - name: Events description: Retrieve and list account events. - name: VPP Programs description: >- Define and manage VPP programs: the commercial terms devices enroll under, and their live state. - name: Groups description: >- Named collections of devices for bulk dispatch and aggregated reads. OEMs see them read-only as [groups](/energy-api/reference/groups/list) on the Energy API. - name: Zones description: >- Network areas resolved to devices by Flatpeak, for locational eligibility and grouping without handling addresses. - name: Exports description: >- Package settlement evidence, consent records and enrollment registers as downloadable files. - name: Rewards description: >- The reward ledger: entries accrue from delivery, you approve them, pay the customers and mark them paid. - name: VPP Enrollments description: Track and act on device enrollments across your programs. - name: VPP Events description: >- Commit market activations: create an event for a group, then read its state and its devices' results. externalDocs: description: Documentation url: https://docs.flatpeak.com paths: /groups: parameters: [] post: tags: - Groups summary: Create a group description: >- Creates a group with exactly one of `device_ids` (explicit) or `filter` (dynamic). Filter groups re-evaluate membership continuously. operationId: create-a-group parameters: [] requestBody: $ref: '#/components/requestBodies/GroupCreate' responses: '201': $ref: '#/components/responses/Group' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '503': $ref: '#/components/responses/503' components: requestBodies: GroupCreate: description: Group payload. required: true content: application/json: schema: $ref: '#/components/schemas/GroupCreate' examples: filter: summary: Filter group value: name: Bristol batteries filter: device_types: - BATTERY_STORAGE program_id: vpr_5c8d1f2a7b3e4d6c9a0f1b2c zone_id: zon_9b3c5d7e1f2a4b6c8d0e2f4a max_response_seconds: 600 explicit: summary: Explicit group value: name: Pilot homes device_ids: - dev_63a6087272941ef077a8fd3e - dev_7a1c2e3f4b5d6a7c8e9f0a1b responses: '400': description: >- 400 Bad Request: the request was malformed or a required field is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: '401 Unauthorized: authentication credentials are missing or invalid.' content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: '403 Forbidden: you do not have permission to access this resource.' content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: '404 Not Found: the requested resource does not exist.' content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: >- 422 Unprocessable Entity: the request is well-formed but cannot be processed, for example missing required data. content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: '429 Too Many Requests: the rate limit has been exceeded.' content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: >- 500 Internal Server Error: an unexpected error occurred. Safe to retry with backoff. content: application/json: schema: $ref: '#/components/schemas/Error' '503': description: >- 503 Service Unavailable: the service is temporarily down for maintenance. Retry after the indicated delay. content: application/json: schema: $ref: '#/components/schemas/Error' Group: description: Group response. content: application/json: schema: $ref: '#/components/schemas/Group' example: 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' schemas: GroupCreate: title: GroupCreate type: object description: Group create payload. Provide exactly one of `device_ids` or `filter`. properties: name: type: string example: Bristol batteries description: Group name, for your own reference. device_ids: type: array items: type: string description: Explicit member devices. Provide either this or `filter`, not both. example: - dev_63a6087272941ef077a8fd3e filter: type: object properties: device_types: type: array items: type: string description: Device types the group includes. example: - BATTERY_STORAGE program_id: type: string description: Devices enrolled in this program. example: vpr_5c8d1f2a7b3e4d6c9a0f1b2c zone_id: type: string description: Devices resolved into this network zone. example: zon_9b3c5d7e1f2a4b6c8d0e2f4a min_response_seconds: type: number nullable: true description: >- Include devices whose median `response_time.total_seconds` is at or above this value. Membership re-evaluates as medians move. example: 60 max_response_seconds: type: number nullable: true description: >- Include devices whose median `response_time.total_seconds` is at or below this value. Devices with no measured response time are excluded when either bound is set. Membership re-evaluates as medians move. example: 600 description: >- Dynamic membership rule. Provide either this or `device_ids`, not both. required: - name Group: title: Group type: object description: >- 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](/fleet-api/reference/groups/list-devices). properties: id: type: string description: Flatpeak Group ID. example: grp_2f6a9c1d8e3b5a7c4d0e9f1a object: type: string example: group description: Object type, `group`. enum: - group live_mode: type: boolean description: '`true` for live data, `false` for test data.' example: true name: type: string example: Bristol batteries description: Group name, for your own reference. filter: type: object nullable: true description: >- Dynamic membership rule. `null` for a group made from an explicit device list. properties: device_types: type: array items: type: string enum: - BATTERY_STORAGE - ELECTRIC_VEHICLE - EV_CHARGER - PV_SYSTEM - OTHER description: Device types the group includes. example: - BATTERY_STORAGE program_id: type: string nullable: true description: Devices enrolled in this program. example: vpr_5c8d1f2a7b3e4d6c9a0f1b2c zone_id: type: string nullable: true description: >- Devices resolved into this [network zone](/fleet-api/reference/zones/retrieve). example: zon_9b3c5d7e1f2a4b6c8d0e2f4a min_response_seconds: type: number nullable: true description: >- Include devices whose median `response_time.total_seconds` is at or above this value. Membership re-evaluates as medians move. example: 60 max_response_seconds: type: number nullable: true description: >- Include devices whose median `response_time.total_seconds` is at or below this value. Devices with no measured response time are excluded when either bound is set. Membership re-evaluates as medians move. example: 600 device_count: type: integer readOnly: true description: Current member count. example: 214 time_created: type: string format: date-time description: Time when the object was created, in UTC. example: '2026-08-12T09:30:00Z' account_id: type: string description: Flatpeak Account ID of the operator that owns the group. example: acc_649d465ede6a785d2fa5f905 required: - id - object - live_mode - name - filter - device_count - time_created - account_id Error: type: object description: Standard error envelope returned by every non-2xx response. required: - object - type - code - message properties: object: type: string enum: - error default: error description: Object type. type: type: string description: High-level error category. example: invalid_request code: type: string description: Machine-readable error code, safe to branch on. example: access_denied message: type: string description: Human-readable description of the error. example: The requested resource could not be found. context: type: string description: Optional originating context, for example `api.price_get`. example: api.price_get live_mode: type: boolean description: Whether the error occurred against live or test data. time_created: type: string format: date-time description: Time the error was generated (RFC 3339). example: '2026-01-01T00:00:00Z' securitySchemes: bearerAuth: type: http scheme: bearer description: >- Authenticate with the `bearer_token` obtained from the [authentication](/fleet-api/reference/authentication) endpoint. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.