Get Sites - Flip Energy API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

skip

integer

optional

limit

integer

optional

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200Success

application/json

Body

array of:

id

string

Id

required

The ID of the site in your system.

Example:

abc-789

created_at

string <date-time>

Created At

read-onlyrequired

updated_at

string <date-time>

Updated At

read-onlyrequired

first_name

string | null

optional

Example:

John

last_name

string | null

optional

Example:

Doe

company_name

string | null

optional

Ony if the customer is a company

Example:

ABC Co.

email

string <email> | null

optional

state_code

enum<string> | enum<null>

State code

optional

Two-character code representing a US state or territory.

Allowed values:

AKALARAZCACOCTDEFLGAHIIAIDILINKSKYLAMAMDMEMIMNMOMSMTNCNDNENHNJNMNVNYOHOKORPAPRRISCSDTNTXUTVAVTWAWIWVWY

city

string | null

City

optional

Example:

San Francisco

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

Example:

123 Main St

street_address2

string | null

Street Address2

optional

service_account_id

string | null

Service Account Id

deprecated

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

Example:

deprecated

Example

[
    {
        "id": "abc-789",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "first_name": "John",
        "last_name": "Doe",
        "company_name": "ABC Co.",
        "email": "[email protected]",
        "state_code": "AK",
        "city": "San Francisco",
        "zip_code": "88800",
        "street_address": "123 Main St",
        "street_address2": "string",
        "service_account_id": "deprecated"
    }
]