Flip Energy API
  1. Programs
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
        GET
      • Read Program
        GET
    • 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
  1. Programs

Read Program

Cloud Mock
https://mock.apidog.com/m1/479670-0-default
Cloud Mock
https://mock.apidog.com/m1/479670-0-default
GET
/v1/site/{siteId}/program/{id}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://mock.apidog.com/m1/479670-0-default/v1/site//program/'

Responses

🟢200Successful Response
application/json
Body

Example
{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "Demo Program",
    "description": "This demo program is for demo purposes.",
    "eligible_device_types": [
        "BATTERY"
    ],
    "can_auto_enroll": true,
    "minimum_reserve_percentage": 20,
    "minimum_commitment_months": 12,
    "participation_months": [
        1
    ],
    "earnings_for_site_upfront": 1000,
    "earnings_for_site_yearly": 500,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "enrollment_form": [
        {
            "name": "account_id",
            "label": "Utility Account Number",
            "type": "boolean",
            "hint": "You can find it on your utility bill. [Learn more](https://example.com)"
        }
    ],
    "terms_and_conditions_version": "2025-01-01",
    "terms_and_conditions_text": "**Terms and conditions** You agree to these mock terms."
}
🟠400Invalid input
🟠404Record not found
Modified at 2024-05-21 17:49:05
Previous
Read Programs
Next
Read Site
Built with