- Overview
- Important concepts
- Authentication
- Enrollment process
- End-user app design
- Monitoring / Telemetry
- Control
- Change log
- Mobile App API
- Cloud API
- Sites
- Commissioning
- Sessions
- Commands
- Programs
- Telemetry
- Webhooks
Read Programs
Cloud Mock
https://mock.apidog.com/m1/479670-0-default
Cloud Mock
https://mock.apidog.com/m1/479670-0-default
GET
/v1/site/{siteId}/programs
programs
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************
Path Params
siteId
string
required
Query Params
zip_code
string
Zip Code
Example:
88801
device_type
enum<string>
required
Allowed values:
BATTERYEV_CHARGER
skip
integer
Skip
Default:
0
limit
integer
Limit
Default:
100
Request 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//programs?zip_code=88801&device_type=&skip&limit'
Responses
🟢200Successful Response
application/json
Body
array of:
id
string <uuid>
Id
name
string
Name
Example:
Demo Program
description
string
required
Example:
This demo program is for demo purposes.
eligible_device_types
array[string]
Eligible Device Types
Allowed values:
BATTERYEV_CHARGER
can_auto_enroll
boolean
required
minimum_reserve_percentage
integer
required
Example:
20
minimum_commitment_months
integer | null
required
Example:
12
participation_months
array[integer]
required
earnings_for_site_upfront
integer
required
Example:
1000
earnings_for_site_yearly
integer
required
Example:
500
created_at
string <date-time>
Created At
updated_at
string <date-time>
Updated At
enrollment_form
array [object {4}]
required
name
string
required
Example:
account_id
label
string
required
Example:
Utility Account Number
type
enum<string>
required
Allowed values:
booleannumberstring
hint
string
optional
Example:
You can find it on your utility bill. [Learn more](https://example.com)
terms_and_conditions_version
string | null
required
Example:
2025-01-01
terms_and_conditions_text
string | null
required
Example:
**Terms and conditions** You agree to these mock terms.
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