Skip to main content
POST
/
v1
/
onboarding
/
status
/
get
get onboarding status
curl --request POST \
  --url https://api.example.com/v1/onboarding/status/get \
  --header 'Content-Type: application/json' \
  --data '
{
  "homeId": "<string>"
}
'
{
  "id": "<string>",
  "homeId": "<string>",
  "status": "NOT_STARTED",
  "eligibilityStatus": "eligible",
  "thermostatBrandName": "<string>",
  "zipcode": "<string>",
  "step": 123
}

Headers

​
x-ws-api-key
string

WattShift API Key

Body

application/json
​
homeId
string
required

Response

200 - application/json
​
id
string | null
required

Unique identifier of the onboarding flow

​
homeId
string
required
​
status
enum<string>
required
Available options:
NOT_STARTED,
IN_PROGRESS,
COMPLETED,
ERROR
​
eligibilityStatus
enum<string> | null
required

Eligibility status of the device and region

Available options:
eligible,
notEligible
​
thermostatBrandName
string | null
required
​
zipcode
string | null
required

Zipcode of home

Pattern: ^(?:0{0,4}[0-9]{1,5}|[0-9]{3})(?:[-\s][0-9]{4})?$
​
step
number | null
required

The number of steps the user has completed