Skip to main content
GET
Retrieve device instructions

Authorizations

Authorization
string
header
required

Bearer token obtained from POST /auth/tokens.

Path Parameters

device_id
string
required

Flatpeak Device ID.

Example:

"dev_63a6087272941ef077a8fd3e"

Query Parameters

end_time
string<date-time>
required

RFC 3339 end of the window, for example 2026-06-15T13:00:00Z. The window starts now and may extend at most 72 hours.

Example:

"2026-06-16T09:00:00Z"

Response

200 OK: the device's instructions.

The VPP operator's instructions for the device over the window, merged into one timeline: VPP event commitments, and plans under a managed tariff. Where a commitment overlaps a plan, the commitment replaces it for that window. Segments are chronological and never overlap. Each is binding and names its vpp_event_id or plan_id. data is empty when there is nothing to follow.

object
enum<string>
required

Object type, instructions.

Available options:
instructions
Example:

"instructions"

live_mode
boolean
required

true for live data, false for test data.

Example:

true

device_id
string
required

Flatpeak Device ID.

Example:

"dev_6563a6757360a6d6a628e839"

location_id
string
required

Flatpeak Location ID.

Example:

"loc_641b90b758fb8e6293716e40"

timezone
string
required

Timezone at the location, tz database name such as Europe/Berlin.

Example:

"Europe/London"

data
InstructionSegment · object[]
required

Instruction segments, in chronological order and non-overlapping. Empty when there are none.

account_id
string
required

Flatpeak Account ID.

Example:

"acc_661677911f2197045e6cf1b1"

time_created
string<date-time>
required

Time when this object was created, in UTC.

Example:

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