Skip to main content
GET
Retrieve a VPP event

Authorizations

Authorization
string
header
required

Bearer token obtained from POST /auth/tokens.

Path Parameters

vpp_event_id
string
required

Flatpeak VPP Event ID.

Response

VPP event response.

A VPP event as it applies to your fleet: the VPP operator's committed power per interval and the allocation of your devices' shares. Flatpeak allocates the shares. At lock, each share becomes a commitment in the device's instructions.

id
string
required

Flatpeak VPP Event ID.

Example:

"vpe_7d2a4c6e9b1f3a5c8e0d2f4b"

object
enum<string>
required

Object type, vpp_event.

Available options:
vpp_event
Example:

"vpp_event"

live_mode
boolean
required

true for objects created in live mode.

Example:

true

operator_id
string
required

Flatpeak ID of the VPP operator.

Example:

"opr_6a3548352c0d07e89d47b7f1"

start_time
string<date-time>
required
read-only

Event envelope start: the first interval's start, in UTC. Read only.

Example:

"2026-08-25T18:00:00Z"

end_time
string<date-time>
required
read-only

Event envelope end: the last interval's end, in UTC. Read only.

Example:

"2026-08-25T20:00:00Z"

intervals
object[]
required

The shape of the event as it applies to your fleet: one or more ordered, non-overlapping intervals, each carrying your fleet's committed share for that interval, signed: positive import, negative export.

Minimum array length: 1
group_id
string
required
read-only

Flatpeak Group ID: the VPP operator's group the event was created for. Your devices that were in the group at that moment are in the event. Read it with retrieve a group.

Example:

"grp_2f6a9c1d8e3b5a7c4d0e9f1a"

status
enum<string>
required
Available options:
ALLOCATION_OPEN,
LOCKED,
ACTIVE,
COMPLETE,
CANCELED
Example:

"ALLOCATION_OPEN"

time_allocation_locks
string<date-time>
required

Time after which the allocation is fixed, in UTC. Until then Flatpeak may rebalance shares.

Example:

"2026-08-25T16:00:00Z"

allocation
object[]
required
read-only

The current allocation per device and window. Rows tile the event's intervals; a device with no row for a window was given no share for it.

time_created
string<date-time>
required

Time when the event was created, in UTC.

Example:

"2026-08-25T14:00:12Z"

account_id
string
required

Flatpeak Account ID.

Example:

"acc_661677911f2197045e6cf1b1"

event_type
enum<string>
read-only

ECONOMIC: market-driven, the default. TEST: exercises the dispatch chain without settlement.

Available options:
ECONOMIC,
TEST
Example:

"ECONOMIC"

device_count
integer
read-only

Your devices in the event: those that were in the VPP operator's group when the event was created.

Example:

61

time_updated
string<date-time>

Time when the event was created or last updated, in UTC.

Example:

"2026-08-25T14:00:12Z"