Read Event - Flip Energy API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

siteId

string

required

id

string <uuid>

required

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200Success

application/json

Body

id

string <uuid>

read-onlyrequired

program_id

string <uuid>

required

site_id

string

required

Example:

abc-789

starts_at

string <date-time>

read-onlyrequired

Time at which the event starts.

Example:

2025-04-30 12:00:00.000Z

ends_at

string <date-time> | null

read-onlyrequired

Time at which the event ends. If null, the event will continue until the utility sends a termination signal.

Example:

2025-04-30 14:00:00.000Z

duration_s

number | null

required

Duration of the event, in seconds. If null, the event will continue until the utility sends a termination signal.

Example:

7200

schedule

array [object {6}]

required

Use this to build a schedule for the event to show the end-user. Not enough information is provided here to send instructions to devices. Please use Commands instead.

device_ids

array[string]

required

starts_at

string <date-time>

read-onlyrequired

Time at which the action should start. Note that this may be before the event itself has started. For instance, in order to pre-charge a battery prior to a discharge event.

Example:

2025-04-30 12:00:00.000Z

ends_at

string <date-time> | null

read-onlyrequired

Time at which the action should stop. If null, the action should continue until replaced by another one.

Example:

2025-04-30 14:00:00.000Z

duration_s

number | null

read-onlyrequired

Duration of the action, in seconds. If null, the action should continue until replaced by another one.

Example:

7200

is_preparatory_action

boolean

read-onlyrequired

Whether the command is not part of the event itself but in preparation for the event. For instance, charging a battery before a discharging event.

mode

enum<string>

required

The mode the battery should go into during this period.

Allowed values:

BACKUPCHARGEDISCHARGESAVINGSSELF_CONSUMPTIONSTANDBY

device_settings

array[object (EventBatterySettings) {3}]

deprecated

Settings per device for the event.

device_id

string

deprecated

backup_reserve_percentage

integer | null

deprecated

The minimum state of charge the battery will keep when discharging.

>= 0<= 100

maximum_charge_percentage

integer | null

deprecated

The maximum state of charge the battery will charge to.

>= 0<= 100

status

enum<string>

read-onlyrequired

Allowed values:

ACTIVECANCELEDCOMPLETEDUPCOMING

is_participating

boolean

required

created_at

string <date-time>

read-onlyrequired

updated_at

string <date-time>

read-onlyrequired

Example

{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "program_id": "70c1146b-e933-4cb2-a789-bbca5312b517",
    "site_id": "abc-789",
    "starts_at": "2025-04-30 12:00:00.000Z",
    "ends_at": "2025-04-30 14:00:00.000Z",
    "duration_s": 7200,
    "schedule": [
        {
            "device_ids": [
                "xyz-123"
            ],
            "starts_at": "2025-04-30 12:00:00.000Z",
            "ends_at": "2025-04-30 14:00:00.000Z",
            "duration_s": 7200,
            "is_preparatory_action": true,
            "mode": "BACKUP"
        }
    ],
    "device_settings": [
        {
            "device_id": "string",
            "backup_reserve_percentage": 0,
            "maximum_charge_percentage": 0
        }
    ],
    "status": "ACTIVE",
    "is_participating": true,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
}

🟠404Record not found