# 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): 
- 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): 

## 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, most recent first (starts_at DESC). 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): 
- 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 > 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 > 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 > 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 > Programs [Read Programs](https://docs.flip.energy/api-15743638.md): Get the programs available for the given parameters.
- 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.