Flip Energy API
    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
        • Read Event
        • Update Event Participation
      • 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

    Change log

    Here we keep track of changes made to the API.
    Note that deprecated input values will not cause an error if provided in requests, but will be ignored unless otherwise noted.

    2025/06/12#

    Telemetry schema#

    Added is_weather_alarm_active as an optional attribute.

    2025/04/30#

    Site schema#

    Added validation on state_code to ensure that values are valid 2-letter US state codes.

    2025/04/29#

    Command schema#

    Change: backwards-compatible
    enable_grid_export is deprecated.
    maximum_charge_percentage is deprecated.

    POST /v1/commission#

    Change: backwards-compatible
    can_auto_enroll is now optional.

    2025/04/25#

    POST /v1/telemetry/BATTERY#

    Change: backwards-compatible
    It's now easier to submit multiple telemetry reports from different start times via a single request. telemetry.start_time now replaces start_time, and telemetry.duration_s now replaces duration_s. The old format will remain valid until further notice.
    battery_last_backup_reserve_percentage is deprecated and not replaced.
    battery_last_stored_energy_wh is deprecated and replaced with battery_last_state_of_charge_percentage.
    battery_last_capacity_energy_wh is deprecated and replaced with battery_last_state_of_health_percentage.

    PATCH /v1/command/{id}#

    Change: backwards-compatible
    The FAILED device status is deprecated and replaced by two new statuses: FAILED_OFFLINE, which tells us that we should retry sending the webhook, and FAILED_FAULT, which tells us that the command could not be executed and therefore the device will not be responding to the event. FAILED will be considered as FAILED_FAULT.

    2025/04/14#

    Program schema#

    Change: backwards-compatible
    The enrollment_form was given a new attribute called hint, which contains helpful text that can be displayed below the form input.

    Site schema#

    Change: backwards-compatible
    The service_account_id attribute was deprecated. It will be replaced on a case-by-case basis by attributes in the program's enrollment_form.

    2025/04/01#

    Event schema#

    Change: breaking
    device_settings was deprecated. It will continue to be returned for the time being but should be removed from your implementation as early as possible.

    Program schema#

    Change: backwards-compatible
    Added minimum_reserve_percentage, which represents the minimum SOC the program authorizes to discharge to.
    Modified at 2025-06-12 14:43:26
    Previous
    Control
    Next
    Create Device
    Built with