Skip to main content
POST
/
v1
/
homes
/
list
list homes
curl --request POST \
  --url https://api.example.com/v1/homes/list \
  --header 'x-ws-api-key: <api-key>'
[
  {
    "id": "ws_home_123456789",
    "createdAt": "2025-01-02T12:00:00.000Z",
    "updatedAt": "2025-01-02T12:00:00.000Z",
    "name": "My home",
    "userId": "user_123456789",
    "UtilityId": "12199",
    "ratePlanId": "6915de25881cbc6041e4c7f1",
    "unstructuredAddress": null,
    "timezone": "America/Los_Angeles",
    "country": "US",
    "city": "San Francisco",
    "zipcode": "94107",
    "streetAddress": "123 Market St",
    "meterId": null,
    "meterIdSource": null,
    "energyMarketBiddingEnabled": true,
    "enabled": true,
    "carbonSignalIntensity": "MEDIUM",
    "channelPartnerId": null
  }
]

Authorizations

x-ws-api-key
string
header
required

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
channelPartnerId
string | null