> ## Documentation Index > Fetch the complete documentation index at: /docs/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve a VPP program summary > Returns the program's enrollment counts by lifecycle state and the enrolled fleet's aggregate `capacity`. ## OpenAPI ````yaml fleet-api/reference/flatpeak-api-spec-fleet.json GET /vpp-programs/{program_id}/summary 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-programs/{program_id}/summary: parameters: - schema: type: string name: program_id in: path required: true description: Flatpeak Program ID. get: tags: - VPP Programs summary: Retrieve a VPP program summary description: >- Returns the program's enrollment counts by lifecycle state and the enrolled fleet's aggregate `capacity`. operationId: get-vpp-program-summary parameters: [] responses: '200': $ref: '#/components/responses/VppProgramSummary' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '503': $ref: '#/components/responses/503' components: responses: '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' '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' VppProgramSummary: description: Program state response. content: application/json: schema: $ref: '#/components/schemas/VppProgramSummary' example: object: vpp_program_summary program_id: vpr_5c8d1f2a7b3e4d6c9a0f1b2c enrollment_counts: active: 1874 pending: 41 suspended: 12 leaving: 3 capacity: dispatchable_import_power_kw: 8460 dispatchable_export_power_kw: 7920 storage_capacity_kwh: 27400 time_created: '2026-08-15T10:30:00Z' schemas: VppProgramSummary: type: object title: VppProgramSummary description: >- The live state of a program: enrollments by lifecycle state and what the fleet can do now. Generated per request. The configuration is on the [Program](/fleet-api/reference/vpp-programs/retrieve). additionalProperties: false required: - object - program_id - enrollment_counts - capacity - time_created properties: object: type: string description: Object type, `vpp_program_summary`. example: vpp_program_summary enum: - vpp_program_summary program_id: type: string description: Flatpeak Program ID. example: vpr_5c8d1f2a7b3e4d6c9a0f1b2c enrollment_counts: type: object description: >- Enrollments by lifecycle state. `pending` holds onboarding and your approval queue. A rising `suspended` count needs attention. additionalProperties: false required: - active - pending - suspended - leaving properties: active: type: integer description: Enrollments in `ACTIVE`. example: 1874 pending: type: integer description: >- Enrollments in `PENDING`, including any waiting at `AWAITING_APPROVAL` for your decision. example: 41 suspended: type: integer description: Enrollments in `SUSPENDED`. example: 12 leaving: type: integer description: Enrollments in `LEAVING`. example: 3 capacity: type: object description: >- Aggregate capability of the enrolled fleet, summed from device envelopes. What you can commit for a window is the capacity forecast. additionalProperties: false required: - dispatchable_import_power_kw - dispatchable_export_power_kw - storage_capacity_kwh properties: dispatchable_import_power_kw: type: number description: >- Total power the enrolled fleet can draw from the grid, in kilowatts. example: 8460 dispatchable_export_power_kw: type: number description: >- Total power the enrolled fleet can export to the grid, in kilowatts. example: 7920 storage_capacity_kwh: type: number description: Total usable storage across the enrolled fleet, in kWh. example: 27400 time_created: type: string description: Time this snapshot was generated, in UTC. format: date-time example: '2026-08-15T10:30:00Z' 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.