Read Programs

Get the programs available for a given site. In the sandbox, valid zip codes are 88800, 88801 and 88802.

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

required

On sandbox, use 88800, 88801 or 88802 to return results.

Example:

88801

device_type

enum<string>

required

Allowed values:

BATTERYEV_CHARGER

skip

integer

Skip

optional

Default:

limit

integer

Limit

optional

Default:

100

Responses

🟢200Successful Response

application/json

Body

array of:

string <uuid>

required

name

string

Name

required

description

string

required

eligible_device_types

array[string]

Eligible Device Types

required

Allowed values:

BATTERYEV_CHARGER

can_auto_enroll

boolean

required

minimum_reserve_percentage

integer

required

The lowest SOC the battery can reach during events

minimum_commitment_months

integer | null

required

Can be null if the minimum commitment is currently not known.

participation_months

array[integer]

required

List of calendar months (range 1-12) in which the program is active

earnings_for_site_upfront

integer

required

Estimated one-time upfront earnings in the program, based on the site information

earnings_for_site_yearly

integer

required

Estimated yearly recurring earnings in the program, based on the site information

created_at

string <date-time>

Created At

required

updated_at

string <date-time>

Updated At

required

enrollment_form

array [object {4}]

required

A program might require special information from the end user on enrollment. If it does, this array will contain each of them. They should be used to dynamically convert into form fields.

name

string

required

The machine-readable attribute name to use over the API

label

string

required

The human-readable attribute name to include in your form

type

enum<string>

required

Allowed values:

booleannumberstring

hint

string

optional

Additional description of the input, in Markdown format

terms_and_conditions_version

string | null

required

If a program requires terms and conditions to be agreed with, the current version will be provided here. It should not be displayed to the user.

terms_and_conditions_text

string | null

required

If a program requires terms and conditions to be agreed with, the full text of the current version, in Markdown format, will be provided here. It should be displayed to the user.

Example

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "description": "string",
    "eligible_device_types": [
      "BATTERY"
    ],
    "can_auto_enroll": true,
    "minimum_reserve_percentage": 0,
    "minimum_commitment_months": 0,
    "participation_months": [
      0
    ],
    "earnings_for_site_upfront": 0,
    "earnings_for_site_yearly": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "enrollment_form": [
      {
        "name": "string",
        "label": "string",
        "type": "boolean",
        "hint": "string"
      }
    ],
    "terms_and_conditions_version": "string",
    "terms_and_conditions_text": "string"
  }
]

🟠400Invalid input

Request

Request samples

Responses