Flip Energy API
  1. Events
Flip Energy API
  • Overview
  • Important concepts
  • Authentication
  • Enrollment process
  • End-user app design
  • Monitoring / Telemetry
  • Control
  • Change log
  • Mobile App API
    • Devices
      • Create Device
      • Read Devices
      • Read Device
      • Update Device
      • Delete Device
    • Enrollments
      • Create Enrollment
      • Read Enrollments
      • Read Enrollment
      • Delete Enrollment
    • Events
      • Read Events
        GET
      • Read Event
        GET
      • Update Event Participation
        PATCH
    • Programs
      • Read Programs
      • Read Program
    • Sites
      • Read Site
      • Update Site
  • Cloud API
    • Sites
      • Get Site Token
      • Get Sites
    • Commissioning
      • Commission Site And Devices
    • Sessions
      • Sessions
    • Commands
      • Command Created
      • Update Command Status
    • Programs
      • Read Programs
    • Telemetry
      • Report Battery Telemetry
    • Webhooks
      • Overview
      • List of events
      • Webhook headers
      • Schemas
        • Command
        • Enrollment
        • Event
  1. Events

Read Events

Cloud Mock
https://mock.apidog.com/m1/479670-0-default
Cloud Mock
https://mock.apidog.com/m1/479670-0-default
GET
/v1/site/{siteId}/events
Returns all events for this site, most recent first (starts_at DESC). Use the status parameter to filter out events.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params

Query Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://mock.apidog.com/m1/479670-0-default/v1/site//events?status'

Responses

🟢200Success
application/json
Body

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
Modified at 2025-03-24 11:33:48
Previous
Delete Enrollment
Next
Read Event
Built with