get user preference

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

Show child attributes

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