> ## Documentation Index > Fetch the complete documentation index at: /docs/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve a device state > Retrieves the latest submitted device state. ## OpenAPI ````yaml fleet-api/reference/flatpeak-api-spec-fleet.json GET /devices/{device_id}/state 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: /devices/{device_id}/state: parameters: - schema: type: string name: device_id in: path required: true description: Flatpeak Device ID. get: tags: - Telemetry summary: Retrieve a device state description: Retrieves the latest submitted device state. operationId: get-device-state parameters: [] responses: '200': $ref: '#/components/responses/DeviceState' '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' DeviceState: description: Device state response. content: application/json: schema: $ref: '#/components/schemas/DeviceState' example: object: device_state device_id: dev_63a6087272941ef077a8fd3e oem_id: oem_6a3a8dada72cd0a249ff9528 time_recorded: '2026-07-08T19:30:00Z' available: true power_kw: -3.4 state_of_charge_percent: 34.2 available_import_energy_kwh: 5.9 available_export_energy_kwh: 5.5 schemas: DeviceState: type: object title: DeviceState description: >- The most recent operational state of a device: the live envelope at the grid connection point. Flatpeak computes it from what the OEM submits, so inverter limits, the backup reserve and current conditions are already accounted for. properties: object: type: string example: device_state description: Object type, `device_state`. enum: - device_state default: device_state device_id: type: string description: Flatpeak Device ID of the device this state belongs to. example: dev_63a6087272941ef077a8fd3e oem_id: type: string pattern: ^oem_[A-Za-z0-9]+$ example: oem_6a3a8dada72cd0a249ff9528 description: 'Flatpeak OEM ID: the OEM that submitted the state.' time_recorded: type: string example: '2026-07-08T19:30:00Z' description: Time when the measurement was recorded, in UTC. format: date-time available: type: boolean description: >- `true` when the device can be dispatched now. `false` while islanded, holding charge for a storm, or otherwise unable to follow instructions. example: true power_kw: type: number description: >- Power at the grid connection point, in kW. Positive is import, negative is export. example: -3.4 state_of_charge_percent: type: number minimum: 0 maximum: 100 description: >- Current usable state of charge of the dispatchable storage as a percentage from 0 to 100. For `EV_CHARGER` devices, the connected vehicle's state of charge. `null` for a device with no dispatchable storage. example: 34.2 nullable: true available_import_energy_kwh: type: number minimum: 0 description: >- Energy the device can absorb before storage is full, in kWh. `null` for a device with no dispatchable storage. example: 5.9 nullable: true available_export_energy_kwh: type: number minimum: 0 description: >- Energy available for export above the backup reserve, in kWh. `null` for a device with no dispatchable storage. example: 5.5 nullable: true required: - object - device_id - oem_id - time_recorded - available - power_kw - state_of_charge_percent - available_import_energy_kwh - available_export_energy_kwh 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.