Skip to main content

​
The thermostat_schedule Object

Represents a thermostat schedule that activates a configured climate preset on a thermostat at a specified starting time and deactivates the climate preset at a specified ending time.
A thermostat schedule resource.
{
  "climate_preset_key": "eco",
  "created_at": "2025-06-14T16:54:17.946316Z",
  "device_id": "dc1dfc4b-8082-453f-a953-276941af8650",
  "ends_at": "2025-07-14T16:54:17.946313Z",
  "errors": [],
  "is_override_allowed": true,
  "max_override_period_minutes": 90,
  "name": "My Thermostat Schedule",
  "starts_at": "2025-07-12T16:54:17.946313Z",
  "thermostat_schedule_id": "af2cb7f7-9f28-40da-a0a0-e7a008ef7a35",
  "workspace_id": "58419b36-6103-44e5-aa83-2163e90cce01"
}

​
Properties

climate_preset_key String Key of the climate preset to use for the thermostat schedule.
created_at Datetime Date and time at which the thermostat schedule was created.
device_id UUID ID of the desired thermostat device.
ends_at Datetime Date and time at which the thermostat schedule ends, in ISO 8601 format.
errors List of Objects Errors associated with the thermostat schedule.
is_override_allowed Boolean Indicates whether a person at the thermostat can change the thermostat’s settings after the thermostat schedule starts.
max_override_period_minutes Number Number of minutes for which a person at the thermostat can change the thermostat’s settings after the activation of the scheduled climate preset. See also Specifying Manual Override Permissions.
name String User-friendly name to identify the thermostat schedule.
starts_at Datetime Date and time at which the thermostat schedule starts, in ISO 8601 format.
thermostat_schedule_id UUID ID of the thermostat schedule.
workspace_id UUID ID of the workspace that contains the thermostat schedule.

​
Endpoints

/thermostats/schedules/create Creates a new thermostat schedule for a specified thermostat. /thermostats/schedules/delete Deletes a thermostat schedule for a specified thermostat. /thermostats/schedules/get Returns a specified thermostat schedule. /thermostats/schedules/list Returns a list of all thermostat schedules for a specified thermostat. /thermostats/schedules/update Updates a specified thermostat schedule.