Read Site - Flip Energy API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

siteId

string

required

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200Successful Response

application/json

Body

id

string

Id

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

email

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.

Example

{
  "id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com",
  "state_code": "st",
  "city": "string",
  "zip_code": "88800",
  "street_address": "string",
  "street_address2": "string",
  "service_account_id": "string"
}

🟠400Invalid input

🟠404Record not found