# Flip Energy API

## Docs
- [Overview](https://docs.flip.energy/doc-567153.md): 
- [Important concepts](https://docs.flip.energy/doc-567179.md): 
- [Authentication](https://docs.flip.energy/doc-455971.md): 
- [Enrollment process](https://docs.flip.energy/doc-567204.md): 
- [End-user app design](https://docs.flip.energy/doc-455995.md): 
- [Monitoring / Telemetry](https://docs.flip.energy/doc-456024.md): 
- [Control](https://docs.flip.energy/doc-512546.md): 
- [Change log](https://docs.flip.energy/doc-973432.md): 
- Cloud API > Commands [Command Created](https://docs.flip.energy/doc-520920.md): 
- Cloud API > Webhooks [Overview](https://docs.flip.energy/doc-492594.md): 
- Cloud API > Webhooks [List of events](https://docs.flip.energy/doc-493258.md): 
- Cloud API > Webhooks [Webhook headers](https://docs.flip.energy/doc-493542.md): 
- Cloud API > Webhooks > Schemas [Command](https://docs.flip.energy/doc-493254.md): 
- Cloud API > Webhooks > Schemas [Enrollment](https://docs.flip.energy/doc-493256.md): 
- Cloud API > Webhooks > Schemas [Event](https://docs.flip.energy/doc-563176.md): 
- Cloud API > Webhooks > Schemas [Settings](https://docs.flip.energy/doc-1889893.md): 

## API Docs
- Mobile App API > Devices [Create Device](https://docs.flip.energy/api-9676085.md): Note that you need the client authentication token (not the site token) to access the API.
- Mobile App API > Devices [Read Devices](https://docs.flip.energy/api-6038139.md): 
- Mobile App API > Devices [Read Device](https://docs.flip.energy/api-6038137.md): 
- Mobile App API > Devices [Update Device](https://docs.flip.energy/api-6038138.md): 
- Mobile App API > Devices [Delete Device](https://docs.flip.energy/api-14590539.md): This endpoint removes a device from a site. However, the site must not be enrolled in any programs before a device can be removed.
- Mobile App API > Enrollments [Create Enrollment](https://docs.flip.energy/api-6038143.md): 
- Mobile App API > Enrollments [Read Enrollments](https://docs.flip.energy/api-6038144.md): 
- Mobile App API > Enrollments [Read Enrollment](https://docs.flip.energy/api-6300100.md): 
- Mobile App API > Enrollments [Delete Enrollment](https://docs.flip.energy/api-6038145.md): 
- Mobile App API > Events [Read Events](https://docs.flip.energy/api-8181468.md): Returns all events for this site, oldests first (starts_at ASC). Use the `status` parameter to filter out events.
- Mobile App API > Events [Read Event](https://docs.flip.energy/api-8282590.md): 
- Mobile App API > Events [Update Event Participation](https://docs.flip.energy/api-8319343.md): 
- Mobile App API > Programs [Read Programs](https://docs.flip.energy/api-6038147.md): Get the programs available for a given site. In the sandbox, valid zip codes are 88800, 88801 and 88802.
- Mobile App API > Programs [Read Program](https://docs.flip.energy/api-6038146.md): 
- Mobile App API > Sites [Read Site](https://docs.flip.energy/api-6038148.md): 
- Mobile App API > Sites [Update Site](https://docs.flip.energy/api-6038149.md): 
- Mobile App API > Sites [List performance reports](https://docs.flip.energy/api-27965229.md): Get performance and payout reports for a site. 
- Cloud API > Commands [Update Command Status](https://docs.flip.energy/api-6039923.md): Use this endpoint to acknowledge commands. If it was properly received set `device_status` to `OK`, otherwise set it to `FAILED`.
- Cloud API > Commissioning [Commission Site And Devices](https://docs.flip.energy/api-6038136.md): Note that you need the client authentication token (not the site token) to access the API.
- Cloud API > Programs [Read Programs](https://docs.flip.energy/api-15743638.md): Get the programs available for the given parameters.
- Cloud API > Sessions [Sessions](https://docs.flip.energy/api-16007610.md): Create a session for the provided site. If the site does not exist in Flip's system, it will be commissioned, otherwise it will be reused. 
- Cloud API > Settings [Update Settings Request Status](https://docs.flip.energy/api-25980251.md): 
- Cloud API > Sites [Get Site Token](https://docs.flip.energy/api-6038135.md): Use this endpoint to retrieve a site token, to be used to authenticate calls between your homeowner app and our API.
- Cloud API > Sites [Get Sites](https://docs.flip.energy/api-8500053.md): Get all registered sites
- Cloud API > Supplements [Add Supplemental Data](https://docs.flip.energy/api-28183185.md): Submit supplementary data from external systems (e.g., CRM records, installation status). The request body is the raw data in any format, JSON, CSV, or plain text. Set the Content-Type header to indicate the format of the data being sent. Note that you need the client authentication token (not the site token) to access the API.
- Cloud API > Telemetry [Report Battery Telemetry](https://docs.flip.energy/api-16287258.md): Batch upload telemetry data points, with a maximum of 1,000 data points per request.
- Cloud API > Telemetry [Report Battery Counter Telemetry](https://docs.flip.energy/api-23837912.md): Batch upload counter-based telemetry data points, with a maximum of 1,000 data points per request.

## Schemas
- Schemas [Event](https://docs.flip.energy/schema-1575061.md): 
- Schemas [Command](https://docs.flip.energy/schema-1575111.md): 
- Schemas [Telemetry](https://docs.flip.energy/schema-1580390.md): 
- Schemas [Utility](https://docs.flip.energy/schema-1589465.md): 
- Schemas [Tariff](https://docs.flip.energy/schema-1589513.md): 
- Schemas [EventStatus](https://docs.flip.energy/schema-1652899.md): 
- Schemas [CommissionBody](https://docs.flip.energy/schema-1574956.md): 
- Schemas [Device](https://docs.flip.energy/schema-1574958.md): 
- Schemas [DeviceInList](https://docs.flip.energy/schema-1656576.md): 
- Schemas [DeviceCreateIn](https://docs.flip.energy/schema-5861317.md): 
- Schemas [DeviceCreateCommissionIn](https://docs.flip.energy/schema-1574959.md): 
- Schemas [DeviceType](https://docs.flip.energy/schema-1574960.md): 
- Schemas [DeviceUpdateIn](https://docs.flip.energy/schema-1574961.md): 
- Schemas [DeviceBatteryConfig](https://docs.flip.energy/schema-1656483.md): 
- Schemas [DeviceBatteryAttributes](https://docs.flip.energy/schema-1656479.md): 
- Schemas [Enrollment](https://docs.flip.energy/schema-1574964.md): 
- Schemas [EnrollmentCreateIn](https://docs.flip.energy/schema-1574965.md): 
- Schemas [HTTPValidationError](https://docs.flip.energy/schema-1574966.md): 
- Schemas [EnrollMethodType](https://docs.flip.energy/schema-1574967.md): 
- Schemas [PeriodType](https://docs.flip.energy/schema-1574968.md): 
- Schemas [Program](https://docs.flip.energy/schema-1574969.md): 
- Schemas [Site](https://docs.flip.energy/schema-1574970.md): 
- Schemas [SortType](https://docs.flip.energy/schema-1574973.md): 
- Schemas [SpecsForBatteries](https://docs.flip.energy/schema-1574974.md): 
- Schemas [UserPreferencesForBatteries](https://docs.flip.energy/schema-1574975.md): 
- Schemas [ValidationError](https://docs.flip.energy/schema-1574976.md): 
- Schemas [VerificationStatus](https://docs.flip.energy/schema-1574977.md): 
- Schemas [AuthResponse](https://docs.flip.energy/schema-1574978.md): 
- Schemas [CommissionResponse](https://docs.flip.energy/schema-1574979.md): 
- Schemas [WebhookEventType](https://docs.flip.energy/schema-1815409.md): 
- Schemas [Webhook - Command](https://docs.flip.energy/schema-1808201.md): 
- Schemas [Webhook - Event](https://docs.flip.energy/schema-2457935.md): 
- Schemas [Webhook - Enrollment](https://docs.flip.energy/schema-1820964.md): 
- Schemas [WebhookBody](https://docs.flip.energy/schema-1818927.md): 
- Schemas [BatteryMode](https://docs.flip.energy/schema-2524361.md): 
- Schemas [EventUpdate](https://docs.flip.energy/schema-2536566.md): 
- Schemas [EventBatterySettings](https://docs.flip.energy/schema-2540127.md): 
- Schemas [BatteryCommand](https://docs.flip.energy/schema-2514635.md): 
- Schemas [BatteryCommandUpdate](https://docs.flip.energy/schema-2536558.md): 
- Schemas [EventScheduleItem](https://docs.flip.energy/schema-2540134.md): 
- Schemas [CommandUpdate](https://docs.flip.energy/schema-2536562.md): 
- Schemas [Telemetry Device](https://docs.flip.energy/schema-2524203.md): 
- Schemas [Counter Telemetry Device](https://docs.flip.energy/schema-10696889.md): 
- Schemas [BatteryPowerMode](https://docs.flip.energy/schema-2524362.md): 
- Schemas [SettingsRequest](https://docs.flip.energy/schema-11844896.md): 
- Schemas [Settings](https://docs.flip.energy/schema-11844909.md):