Skip to main content
GET
Retrieve a device state

Authorizations

Authorization
string
header
required

Bearer token obtained from POST /auth/tokens.

Path Parameters

device_id
string
required

Flatpeak Device ID.

Response

Device state response.

The most recent operational state of a device, grouped by subsystem.

id
string
required

Flatpeak device state record ID.

Pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$
Example:

"dsr_6a284b7596d3f2b722544e70"

object
enum<string>
default:device_state
required

Object type.

Available options:
device_state
Example:

"device_state"

location_id
string
required

Flatpeak Location ID of the device's location.

Pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$
Example:

"loc_641b90b758fb8e6293716e40"

time_recorded
string<date-time>
required

Time the measurement was recorded, in RFC 3339 format.

Example:

"2026-02-01T10:30:00Z"

time_created
string<date-time>
required

Time when this object was created. In UTC.

Example:

"2026-02-01T10:33:00Z"

account_id
string
required

Flatpeak Account ID.

Pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$
Example:

"acc_661677911f2197045e6cf1b1"

record_reference_id
string

Optional unique identifier for the telemetry record, used for idempotency and reconciliation.

Example:

"MET1234567890"

battery
DeviceStateBattery · object

Operational state of a stationary battery.

vehicle
DeviceStateVehicle · object

Operational state of an electric vehicle.

evse
DeviceStateEvse · object

Operational state of an EV charge point.

pv
DeviceStatePv · object

Operational state of solar generation.