Flip Energy API
  1. Schemas
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
      • Report Battery Counter Telemetry
    • Webhooks
      • Overview
      • List of events
      • Webhook headers
      • Schemas
        • Command
        • Enrollment
        • Event
  • Schemas
    • Schemas
      • Event
      • Command
      • Telemetry
      • Counter Telemetry
      • Utility
      • Tariff
      • EventStatus
      • Body_commission_site_and_device_v1_commission_post
      • Device
      • Device Copy
      • DeviceCreateIn
      • DeviceCreateCommissionIn
      • DeviceType
      • DeviceUpdateIn
      • DeviceBatteryConfig
      • DeviceBatteryAttributes
      • Enrollment
      • EnrollmentCreateIn
      • HTTPValidationError
      • EnrollMethodType
      • PeriodType
      • Program
      • Site
      • SortType
      • SpecsForBatteries
      • UserPreferencesForBatteries
      • ValidationError
      • VerificationStatus
      • Response
      • Response
      • WebhookEventType
      • Webhook - Command
      • Webhook - Event
      • Webhook - Enrollment
      • WebhookBody
      • BatteryMode
      • EventUpdate
      • EventBatterySettings
      • BatteryCommand
      • BatteryCommandUpdate
      • EventScheduleItem
      • CommandUpdate
      • Telemetry Device
      • Counter Telemetry Device
      • BatteryPowerMode
  1. Schemas

Command

{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7",
    "device_id": "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,
    "battery_commands": {
        "mode": "BACKUP",
        "power_mode": "FOLLOW_LOAD",
        "setpoint_w": 5000,
        "enable_grid_import": true,
        "backup_reserve_percentage": 20
    },
    "status": "CANCELED",
    "device_status": "FAILED_OFFLINE",
    "device_status_reason": "Command scheduled",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
}
Built with