Flip Energy API

Get Sites

GET/v1/sites

Get all registered sites

Request

Authorization: Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example

Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379

Query Params

skip

integer

optional

limit

integer

optional

Request samples

Responses

Success(200)

HTTP Code: 200

Content Type : JSONapplication/json

array of:

string

required

The ID of the site in your system.

created_at

string <date-time>

Created At

read-onlyrequired

updated_at

string <date-time>

Updated At

read-onlyrequired

first_name

string | null

optional

last_name

string | null

optional

string <email> | null

optional

state_code

string | null

State

optional

>= 2 characters<= 2 characters

city

string | null

City

optional

zip_code

string | null

Zip Code

optional

In the sandbox, use zip codes 88800, 88801 or 88802 to match with test programs.

Examples:

888008880188802

street_address

string | null

Street Address

optional

street_address2

string | null

Street Address2

optional

service_account_id

string | null

Service Account Id

optional

An ID assigned to the residential customer by the utility. Can typically be found on the utility bill.

[
  {
    "id": "string",
    "created_at": "2019-08-24T14:15:22.123Z",
    "updated_at": "2019-08-24T14:15:22.123Z",
    "first_name": "string",
    "last_name": "string",
    "email": "[email protected]",
    "state_code": "st",
    "city": "string",
    "zip_code": "88800",
    "street_address": "string",
    "street_address2": "string",
    "service_account_id": "string"
  }
]

Last modified: 7 months ago