Skip to main content
GET
Retrieve device settings

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 settings record.

The device's desired settings, one record shared with its OEM. Device-local changes are reconciled in from the OEM's state submissions. supported lists the writable field paths; writes outside it return 422. Only the blocks for subsystems the device has are returned.

object
enum<string>
required
read-only

Object type, device_settings.

Available options:
device_settings
Example:

"device_settings"

device_id
string
required
read-only

Flatpeak Device ID of the device these settings belong to.

Example:

"dev_63a6087272941ef077a8fd3e"

oem_id
string
required
read-only

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

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

"oem_6a3a8dada72cd0a249ff9528"

supported
string[]
required
read-only

The field paths that can be written for this device, from its type and declared hardware support. Read only. Empty for device types without settings.

Example:
sync_status
enum<string>
required
read-only

Whether the device has applied the desired settings, from comparing this record with reported state. Numeric fields compare within a tolerance. A null desired value is in sync only with a null reported value. one_off_charge is not compared, because device state does not report it. FAILED fires device.settings.sync_failed.

Available options:
IN_SYNC,
PENDING,
FAILED
Example:

"IN_SYNC"

updated_by
enum<string>
required
read-only

Who made the last change. When two writes change the same field, the last one wins.

Available options:
OPERATOR,
OEM
Example:

"OEM"

time_updated
string<date-time>
required
read-only

When the record last changed, in UTC.

Example:

"2026-08-31T09:12:44Z"

battery
DeviceSettingsBattery · object

Desired operating settings for a battery. All fields are persistent except one_off_charge.

evse
DeviceSettingsEvse · object

Desired operating settings for an EV charger.

vehicle
DeviceSettingsVehicle · object

Desired operating settings for an electric vehicle.