Getting Started

This guide walks you through the key workflows for managing demand response programs via the Flip Utility API.

1. List Enrollments

Retrieve enrollments for a given program to see which sites are available for dispatch:

curl https://api-utility.flip.energy/v1/enrollments?program_id={programId} \
  -H "Authorization: Bearer fl_your_api_key"

2. Create Groups (Optional)

Organize enrollments into groups for targeted event dispatch:

curl -X POST https://api-utility.flip.energy/v1/programs/{programId}/groups \
  -H "Authorization: Bearer fl_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"name": "Zone A", "enrollment_ids": ["...", "..."]}'

3. Dispatch an Event

Create a demand response event to activate enrolled sites:

curl -X POST https://api-utility.flip.energy/v1/events \
  -H "Authorization: Bearer fl_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "program_id": "...",
    "actions": [{"mode": "discharge", "start_at": "...", "end_at": "..."}],
    "target_type": "program",
    "target_ids": ["..."]
  }'

4. Monitor Telemetry

Query real-time or historical telemetry to monitor site performance during events:

curl -X POST https://api-utility.flip.energy/v1/telemetry/latest \
  -H "Authorization: Bearer fl_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"enrollment_ids": ["...", "..."]}'

Next Steps

Explore the API Reference for complete endpoint documentation including request/response schemas.