Skip to main content
POST
/
v1
/
devices
/
hvac
/
{id}
/
user_preferences
/
get
get user preference
curl --request POST \
  --url https://api.example.com/v1/devices/hvac/{id}/user_preferences/get \
  --header 'x-ws-api-key: <api-key>'
{
  "name": "Weekday comfort",
  "tempUnits": "F",
  "defaultMode": "AUTO",
  "defaultMaxTemp": 75,
  "defaultMinTemp": 65,
  "defaultCoolSetpoint": 74,
  "defaultHeatSetpoint": 68,
  "scheduleBlocks": [
    {
      "startTimeMinutes": 0,
      "endTimeMinutes": 480,
      "mode": "HEAT",
      "targetCoolSetpoint": null,
      "targetHeatSetpoint": 68,
      "maxTemp": 75,
      "minTemp": 65,
      "daysOfWeek": [
        1,
        2,
        3,
        4,
        5
      ],
      "scheduleType": "RECURRING"
    },
    {
      "startTimeMinutes": 480,
      "endTimeMinutes": 1440,
      "mode": "AUTO",
      "targetCoolSetpoint": 74,
      "targetHeatSetpoint": 68,
      "maxTemp": 75,
      "minTemp": 65,
      "daysOfWeek": [
        1,
        2,
        3,
        4,
        5
      ],
      "scheduleType": "RECURRING"
    }
  ]
}

Authorizations

​
x-ws-api-key
string
header
required

Headers

​
x-ws-api-key
string

WattShift API Key

Path Parameters

​
id
string
required

Response

200 - application/json
​
name
string
required

The human-readable name for the schedule

Minimum string length: 1
​
scheduleBlocks
object[]
required

0 or more blocks for this schedule to follow. If no blocks are added, the default temp will be followed

​
enabled
boolean
required

Whether this schedule should be enabled

​
tempUnits
enum<string>
required

The units for temperature.

Available options:
F,
C
​
weekNumbers
integer[]

The week numbers to apply this schedule. For example, [0,1,2,...,51] applies to all 52 weeks of the year. Leave empty to also apply to all weeks.

Required range: 0 < x < 52
​
defaultMode
enum<string>
default:AUTO

The default mode for the HVAC unit.

Available options:
OFF,
HEAT,
COOL,
AUTO
​
defaultTemp
number
Required range: -50 < x < 200
​
currentTemp
number

The current temperature

Required range: -50 < x < 200
​
targetTemp
number

The target temperature

Required range: -50 < x < 200
​
targetCoolSetpoint
number

The target cool setpoint

Required range: -50 < x < 200
​
targetHeatSetpoint
number

The target heat setpoint

Required range: -50 < x < 200
​
maxTemp
number

The max default temperature

Required range: -50 < x < 200
​
minTemp
number

The min default temperature

Required range: -50 < x < 200