> ## Documentation Index > Fetch the complete documentation index at: /docs/llms.txt > Use this file to discover all available pages before exploring further. # List all VPP event devices > Returns the devices the event took from its group, one row each, with the device's result for the whole event. Filter by `status` to find the devices that fell short. For one device's full record per interval, use [list device deliveries](/fleet-api/reference/vpp-events/list-device-deliveries) with `vpp_event_id`. ## OpenAPI ````yaml fleet-api/reference/flatpeak-api-spec-fleet.json GET /vpp-events/{vpp_event_id}/devices 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: /vpp-events/{vpp_event_id}/devices: parameters: - schema: type: string name: vpp_event_id in: path required: true description: Flatpeak VPP event ID. get: tags: - VPP Events summary: List all VPP event devices description: >- Returns the devices the event took from its group, one row each, with the device's result for the whole event. Filter by `status` to find the devices that fell short. For one device's full record per interval, use [list device deliveries](/fleet-api/reference/vpp-events/list-device-deliveries) with `vpp_event_id`. operationId: list-vpp-event-devices parameters: - schema: type: string enum: - FULL - PARTIAL - ZERO - UNREPORTED - OPTED_OUT - NOT_COMMITTED example: ZERO name: status in: query required: false description: Only devices with this outcome. - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/cursor' responses: '200': $ref: '#/components/responses/VppEventDeviceList' '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: parameters: limit: name: limit in: query required: false schema: type: integer minimum: 1 maximum: 100 default: 30 description: >- Maximum number of objects to return per page. Between 1 and 100, default 30. Values above 100 are clamped to 100. cursor: name: cursor in: query required: false schema: type: string description: >- Pagination cursor. Pass `next_cursor` from the previous response unchanged; omit for the first page. A cursor used with different parameters returns `400 cursor_invalid`. 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' VppEventDeviceList: description: VPP event device list response. content: application/json: schema: type: object properties: object: type: string description: Object type, `list`. example: list enum: - list url: type: string description: URL slug for the object. example: /vpp-events/{vpp_event_id}/devices next_cursor: type: string nullable: true description: >- Cursor for the next page. Pass it as `cursor`. `null` on the last page. Page until it is `null`, even if `data` is short or empty. example: djF8ZXZ0fGE5ZjN8NjYxNjc3ODdjMTY1MmIzZmJlYmE1ZjAx data: type: array items: $ref: '#/components/schemas/VppEventDevice' required: - object - url - next_cursor - data example: object: list url: /vpp-events/vpe_7d2a4c6e9b1f3a5c8e0d2f4b/devices next_cursor: null data: - object: vpp_event_device device_id: dev_63a6087272941ef077a8fd3e program_id: vpr_5c8d1f2a7b3e4d6c9a0f1b2c status: PARTIAL committed_energy_kwh: -8.6 delivered_energy_kwh: -7.9 fulfillment: 0.92 - object: vpp_event_device device_id: dev_1b2c3d4e5f6a7b8c9d0e1f2a program_id: vpr_5c8d1f2a7b3e4d6c9a0f1b2c status: NOT_COMMITTED committed_energy_kwh: 0 delivered_energy_kwh: null fulfillment: null schemas: VppEventDevice: type: object title: VppEventDevice additionalProperties: false description: >- One device in a VPP event, with its result for the whole event. Every device the event took from the group has a row, whether or not it was given a share. required: - object - device_id - program_id - status - committed_energy_kwh - delivered_energy_kwh - fulfillment properties: object: type: string description: Object type, `vpp_event_device`. example: vpp_event_device enum: - vpp_event_device device_id: type: string description: Flatpeak Device ID. example: dev_63a6087272941ef077a8fd3e program_id: type: string description: >- Program the device is enrolled in. Its opt-out policy and rewards follow that enrollment's `terms`. example: vpr_5c8d1f2a7b3e4d6c9a0f1b2c status: type: string enum: - FULL - PARTIAL - ZERO - UNREPORTED - OPTED_OUT - NOT_COMMITTED example: PARTIAL description: |- The device's outcome over the whole event. | Value | Meaning | | :--- | :--- | | `FULL` | Fulfillment 1 | | `PARTIAL` | Fulfillment between 0 and 1 | | `ZERO` | Metered, nothing delivered | | `UNREPORTED` | No meter records cover its windows | | `OPTED_OUT` | The customer skipped the event | | `NOT_COMMITTED` | In the event, but given no share | committed_energy_kwh: type: number description: >- Energy the device's commitments imply over the event, in kWh, signed: positive import, negative export. `0` when it was given no share. example: -8.6 delivered_energy_kwh: type: number nullable: true description: >- Energy delivered within its committed windows so far, in kWh, signed like the commitment, from meter records. `null` while no meter records cover them. example: -7.9 fulfillment: type: number nullable: true minimum: 0 maximum: 1 description: >- Share of the committed energy delivered, from 0 to 1, energy weighted. `null` while no meter records cover its windows, and when the device holds no commitment. example: 0.92 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.