get user preference

POST

devices

hvac

{id}

user_preferences

get

{
  "name": "<string>",
  "scheduleBlocks": [
    {
      "startTimeMinutes": 720,
      "endTimeMinutes": 720,
      "mode": "OFF",
      "targetTemp": 75,
      "targetCoolSetpoint": 75,
      "targetHeatSetpoint": 75,
      "maxTemp": 75,
      "minTemp": 75,
      "daysOfWeek": [
        3
      ],
      "scheduleType": "RECURRING"
    }
  ],
  "weekNumbers": [
    26
  ],
  "enabled": true,
  "defaultMode": "AUTO",
  "tempUnits": "F",
  "defaultTemp": 75,
  "currentTemp": 75,
  "targetTemp": 75,
  "targetCoolSetpoint": 75,
  "targetHeatSetpoint": 75,
  "maxTemp": 75,
  "minTemp": 75
}

Headers

x-ws-api-key

string

WattShift API Key

Path Parameters

string

required

Response

200 - application/json

name

string

required

The human-readable name for the schedule

Minimum 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.

defaultMode

enum<string>

default:AUTO

The default mode for the HVAC unit.

Available options:

OFF,

HEAT,

COOL,

AUTO

defaultTemp

number