Skip to main content
POST
/
v1
/
homes
/
list
list homes
curl --request POST \
  --url https://api.example.com/v1/homes/list
[
  {
    "id": "<string>",
    "createdAt": "<unknown>",
    "updatedAt": "<unknown>",
    "energyMarketBiddingEnabled": true,
    "carbonSignalIntensity": "LOW",
    "name": "<string>",
    "userId": "<string>",
    "UtilityId": "<string>",
    "ratePlanId": "<string>",
    "unstructuredAddress": "<string>",
    "timezone": "<string>",
    "country": "<string>",
    "city": "<string>",
    "zipcode": "<string>",
    "streetAddress": "<string>",
    "meterId": "<string>",
    "meterIdSource": "<string>",
    "enabled": true
  }
]

Headers

x-ws-api-key
string

WattShift API Key

Response

200 - application/json
id
string
required
createdAt
any
required
updatedAt
any
required
energyMarketBiddingEnabled
boolean
required
carbonSignalIntensity
enum<string>
required
Available options:
LOW,
MEDIUM,
HIGH
name
string | null
userId
string | null
UtilityId
string | null
ratePlanId
string | null
unstructuredAddress
string | null
timezone
string | null
country
string | null
city
string | null
zipcode
string | null
streetAddress
string | null
meterId
string | null
meterIdSource
string | null
enabled
boolean | null