Skip to main content
GET
Retrieve a device

Authorizations

Authorization
string
header
required

Authenticate with the bearer_token obtained from the authentication endpoint.

Path Parameters

device_id
string
required

Flatpeak Device ID.

Response

Device response.

A device connected to your account.

id
string
required
read-only

Flatpeak Device ID.

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

"dev_63a6087272941ef077a8fd3e"

object
enum<string>
default:device
required
read-only

Object type, device.

Available options:
device
Example:

"device"

live_mode
boolean
required

true for live data, false for test data.

device_type
enum<string>
required
read-only

What the device is, as the OEM declares it.

A change of type is rejected while the device is enrolled in one of your programs.

Available options:
BATTERY_STORAGE,
ELECTRIC_VEHICLE,
EV_CHARGER,
PV_SYSTEM,
OTHER
Example:

"BATTERY_STORAGE"

oem_id
string
required

Flatpeak OEM ID: the OEM that connects the device. See list all OEMs.

Pattern: ^oem_[A-Za-z0-9]+$
Example:

"oem_6a3a8dada72cd0a249ff9528"

hardware
DeviceHardware · object
required

Identity of the physical device, as declared by the OEM.

location_id
string
required
read-only

Flatpeak Location ID of the property the device sits behind. Devices at the same property share it; aggregate per location to avoid double counting. The address, coordinates, timezone and currency are on the location.

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

"loc_641b90b758fb8e6293716e40"

Consent scopes the customer has granted you for this device. Grant and revocation times are in consent history.

Available options:
TELEMETRY,
CONTROL,
LOCATION,
SETTINGS
Example:
dispatch_limits
DispatchLimits · object
required

The device's dispatch envelope at the grid connection point, computed by Flatpeak from the OEM's declaration, inverter and connector limits included. Plans are validated against it at submission.

response_time
ResponseTime · object
required

How fast the device's OEM fetches and confirms instructions. Derived by Flatpeak. Read only.

telemetry
Telemetry · object
required

Telemetry status.

time_last_seen
string<date-time> | null
required

Time when Flatpeak last heard from the device, through its OEM's API calls or telemetry, in UTC. null until first contact.

Example:

"2026-03-22T11:12:21Z"

time_created
string<date-time>
required

Time when the object was created, in UTC.

Example:

"2026-01-24T14:15:22Z"