The Thermostat Object

{
  "can_hvac_cool": true,
  "can_hvac_heat": true,
  "can_hvac_heat_cool": true,
  "can_turn_off_hvac": true,
  "capabilities_supported": [
    "thermostat"
  ],
  "connected_account_id": "a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d",
  "created_at": "2024-10-03T22:12:15.666Z",
  "custom_metadata": {
    "id": "internalId1"
  },
  "device_id": "a1b2c3d4-e5f6-7890-1234-56789abcdef0",
  "device_type": "ecobee_thermostat",
  "display_name": "Living Room",
  "errors": [],
  "is_managed": true,
  "space_ids": [],
  "location": {
    "location_name": "2948 20th St, San Francisco, CA, 94110, US",
    "timezone": "America/Los_Angeles"
  },
  "nickname": "Living Room",
  "properties": {
    "active_climate_preset": {
      "can_delete": true,
      "can_edit": true,
      "climate_preset_key": "sleep",
      "cooling_set_point_celsius": 23.88888888888889,
      "display_name": "Sleep",
      "fan_mode_setting": "auto",
      "heating_set_point_celsius": 17.77777777777778,
      "hvac_mode_setting": "heat_cool",
      "manual_override_allowed": true
    },
    "appearance": {
      "name": "Living Room"
    },
    "available_climate_presets": [
      {
        "climate_preset_key": "sleep",
        "can_edit": true,
        "can_delete": true,
        "can_use_with_thermostat_daily_programs": false,
        "name": "Sleep",
        "display_name": "Sleep",
        "fan_mode_setting": "auto",
        "hvac_mode_setting": "heat_cool",
        "manual_override_allowed": true,
        "cooling_set_point_celsius": 23.88888888888889,
        "heating_set_point_celsius": 17.77777777777778,
        "cooling_set_point_fahrenheit": 75,
        "heating_set_point_fahrenheit": 64
      },
      {
        "climate_preset_key": "home",
        "can_edit": true,
        "can_delete": true,
        "can_use_with_thermostat_daily_programs": false,
        "name": "Home",
        "display_name": "Home",
        "fan_mode_setting": "auto",
        "hvac_mode_setting": "heat_cool",
        "manual_override_allowed": false,
        "cooling_set_point_celsius": 23.88888888888889,
        "heating_set_point_celsius": 17.77777777777778,
        "cooling_set_point_fahrenheit": 75,
        "heating_set_point_fahrenheit": 64
      },
      {
        "climate_preset_key": "work",
        "can_edit": true,
        "can_delete": true,
        "can_use_with_thermostat_daily_programs": false,
        "name": "Work",
        "display_name": "Work",
        "fan_mode_setting": "auto",
        "hvac_mode_setting": "heat_cool",
        "manual_override_allowed": false,
        "cooling_set_point_celsius": 23.88888888888889,
        "heating_set_point_celsius": 17.77777777777778,
        "cooling_set_point_fahrenheit": 75,
        "heating_set_point_fahrenheit": 64
      }
    ],
    "available_fan_mode_settings": [
      "auto",
      "on"
    ],
    "available_hvac_mode_settings": [
      "cool",
      "heat",
      "heat_cool",
      "off"
    ],
    "current_climate_setting": {
      "display_name": "Manual Setting",
      "fan_mode_setting": "auto",
      "heating_set_point_celsius": 25,
      "heating_set_point_fahrenheit": 77,
      "hvac_mode_setting": "heat",
      "manual_override_allowed": true
    },
    "ecobee_metadata": {
      "device_name": "Living Room",
      "ecobee_device_id": "a1b2c3d4-e5f6-7890-1234-56789abcdef0"
    },
    "fallback_climate_preset_key": "eco",
    "fan_mode_setting": "auto",
    "has_direct_power": true,
    "image_alt_text": "Ecobee 3 Lite Thermostat",
    "image_url": "https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128",
    "is_cooling": false,
    "is_fan_running": false,
    "is_heating": false,
    "is_temporary_manual_override_active": false,
    "manufacturer": "ecobee",
    "max_cooling_set_point_celsius": 33.333333333333336,
    "max_cooling_set_point_fahrenheit": 92,
    "max_heating_set_point_celsius": 26.11111111111111,
    "max_heating_set_point_fahrenheit": 79,
    "min_cooling_set_point_celsius": 18.333333333333336,
    "min_cooling_set_point_fahrenheit": 65,
    "min_heating_cooling_delta_celsius": 2.7777777777777777,
    "min_heating_cooling_delta_fahrenheit": 5,
    "min_heating_set_point_celsius": 7.222222222222222,
    "min_heating_set_point_fahrenheit": 45,
    "model": {
      "display_name": "Thermostat",
      "manufacturer_display_name": "Ecobee"
    },
    "name": "Living Room",
    "online": true,
    "relative_humidity": 0.36,
    "temperature_celsius": 21.11111111111111,
    "temperature_fahrenheit": 70,
    "temperature_threshold": {
      "lower_limit_celsius": 16.66666666666667,
      "lower_limit_fahrenheit": 62,
      "upper_limit_celsius": 26.66666666666667,
      "upper_limit_fahrenheit": 80
    },
    "thermostat_daily_programs": [
      {
        "thermostat_daily_program_id": "1a2b3c4d-5e6f-7890-1234-56789abcdef1",
        "device_id": "a1b2c3d4-e5f6-7890-1234-56789abcdef0",
        "name": "Weekday Program",
        "periods": [
          {
            "starts_at_time": "00:00:00",
            "climate_preset_key": "sleep"
          },
          {
            "starts_at_time": "07:00:00",
            "climate_preset_key": "home"
          },
          {
            "starts_at_time": "09:00:00",
            "climate_preset_key": "work"
          },
          {
            "starts_at_time": "18:00:00",
            "climate_preset_key": "home"
          },
          {
            "starts_at_time": "22:00:00",
            "climate_preset_key": "sleep"
          }
        ],
        "workspace_id": "9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab",
        "created_at": "2025-05-30T04:01:25.455Z"
      },
      {
        "thermostat_daily_program_id": "d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90",
        "device_id": "a1b2c3d4-e5f6-7890-1234-56789abcdef0",
        "name": "Weekend Program",
        "periods": [
          {
            "starts_at_time": "00:00:00",
            "climate_preset_key": "sleep"
          },
          {
            "starts_at_time": "08:00:00",
            "climate_preset_key": "home"
          },
          {
            "starts_at_time": "23:00:00",
            "climate_preset_key": "sleep"
          }
        ],
        "workspace_id": "9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab",
        "created_at": "2025-05-30T04:02:19.952Z"
      }
    ],
    "thermostat_weekly_program": null
  },
  "warnings": [],
  "workspace_id": "9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab"
}

The device Object for Thermostats

Represents a thermostat. You can use the Seam API to perform the following management and monitoring actions for thermostats:

Monitor current thermostat settings and readings.
Configure temperature thresholds. If the thermostat reports a temperature outside these thresholds, Seam automatically alerts you.
Make immediate changes to thermostat climate settings, such as the HVAC mode and fan mode.
Create and schedule climate presets, including a fallback climate preset.
Create daily and weekly thermostat programs.

The Seam API represents a thermostat as a device resource that includes both basic device properties and thermostat-specific properties.

{
  "can_hvac_cool": true,
  "can_hvac_heat": true,
  "can_hvac_heat_cool": true,
  "can_turn_off_hvac": true,
  "capabilities_supported": [
    "thermostat"
  ],
  "connected_account_id": "a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d",
  "created_at": "2024-10-03T22:12:15.666Z",
  "custom_metadata": {
    "id": "internalId1"
  },
  "device_id": "a1b2c3d4-e5f6-7890-1234-56789abcdef0",
  "device_type": "ecobee_thermostat",
  "display_name": "Living Room",
  "errors": [],
  "is_managed": true,
  "space_ids": [],
  "location": {
    "location_name": "2948 20th St, San Francisco, CA, 94110, US",
    "timezone": "America/Los_Angeles"
  },
  "nickname": "Living Room",
  "properties": {
    "active_climate_preset": {
      "can_delete": true,
      "can_edit": true,
      "climate_preset_key": "sleep",
      "cooling_set_point_celsius": 23.88888888888889,
      "display_name": "Sleep",
      "fan_mode_setting": "auto",
      "heating_set_point_celsius": 17.77777777777778,
      "hvac_mode_setting": "heat_cool",
      "manual_override_allowed": true
    },
    "appearance": {
      "name": "Living Room"
    },
    "available_climate_presets": [
      {
        "climate_preset_key": "sleep",
        "can_edit": true,
        "can_delete": true,
        "can_use_with_thermostat_daily_programs": false,
        "name": "Sleep",
        "display_name": "Sleep",
        "fan_mode_setting": "auto",
        "hvac_mode_setting": "heat_cool",
        "manual_override_allowed": true,
        "cooling_set_point_celsius": 23.88888888888889,
        "heating_set_point_celsius": 17.77777777777778,
        "cooling_set_point_fahrenheit": 75,
        "heating_set_point_fahrenheit": 64
      },
      {
        "climate_preset_key": "home",
        "can_edit": true,
        "can_delete": true,
        "can_use_with_thermostat_daily_programs": false,
        "name": "Home",
        "display_name": "Home",
        "fan_mode_setting": "auto",
        "hvac_mode_setting": "heat_cool",
        "manual_override_allowed": false,
        "cooling_set_point_celsius": 23.88888888888889,
        "heating_set_point_celsius": 17.77777777777778,
        "cooling_set_point_fahrenheit": 75,
        "heating_set_point_fahrenheit": 64
      },
      {
        "climate_preset_key": "work",
        "can_edit": true,
        "can_delete": true,
        "can_use_with_thermostat_daily_programs": false,
        "name": "Work",
        "display_name": "Work",
        "fan_mode_setting": "auto",
        "hvac_mode_setting": "heat_cool",
        "manual_override_allowed": false,
        "cooling_set_point_celsius": 23.88888888888889,
        "heating_set_point_celsius": 17.77777777777778,
        "cooling_set_point_fahrenheit": 75,
        "heating_set_point_fahrenheit": 64
      }
    ],
    "available_fan_mode_settings": [
      "auto",
      "on"
    ],
    "available_hvac_mode_settings": [
      "cool",
      "heat",
      "heat_cool",
      "off"
    ],
    "current_climate_setting": {
      "display_name": "Manual Setting",
      "fan_mode_setting": "auto",
      "heating_set_point_celsius": 25,
      "heating_set_point_fahrenheit": 77,
      "hvac_mode_setting": "heat",
      "manual_override_allowed": true
    },
    "ecobee_metadata": {
      "device_name": "Living Room",
      "ecobee_device_id": "a1b2c3d4-e5f6-7890-1234-56789abcdef0"
    },
    "fallback_climate_preset_key": "eco",
    "fan_mode_setting": "auto",
    "has_direct_power": true,
    "image_alt_text": "Ecobee 3 Lite Thermostat",
    "image_url": "https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128",
    "is_cooling": false,
    "is_fan_running": false,
    "is_heating": false,
    "is_temporary_manual_override_active": false,
    "manufacturer": "ecobee",
    "max_cooling_set_point_celsius": 33.333333333333336,
    "max_cooling_set_point_fahrenheit": 92,
    "max_heating_set_point_celsius": 26.11111111111111,
    "max_heating_set_point_fahrenheit": 79,
    "min_cooling_set_point_celsius": 18.333333333333336,
    "min_cooling_set_point_fahrenheit": 65,
    "min_heating_cooling_delta_celsius": 2.7777777777777777,
    "min_heating_cooling_delta_fahrenheit": 5,
    "min_heating_set_point_celsius": 7.222222222222222,
    "min_heating_set_point_fahrenheit": 45,
    "model": {
      "display_name": "Thermostat",
      "manufacturer_display_name": "Ecobee"
    },
    "name": "Living Room",
    "online": true,
    "relative_humidity": 0.36,
    "temperature_celsius": 21.11111111111111,
    "temperature_fahrenheit": 70,
    "temperature_threshold": {
      "lower_limit_celsius": 16.66666666666667,
      "lower_limit_fahrenheit": 62,
      "upper_limit_celsius": 26.66666666666667,
      "upper_limit_fahrenheit": 80
    },
    "thermostat_daily_programs": [
      {
        "thermostat_daily_program_id": "1a2b3c4d-5e6f-7890-1234-56789abcdef1",
        "device_id": "a1b2c3d4-e5f6-7890-1234-56789abcdef0",
        "name": "Weekday Program",
        "periods": [
          {
            "starts_at_time": "00:00:00",
            "climate_preset_key": "sleep"
          },
          {
            "starts_at_time": "07:00:00",
            "climate_preset_key": "home"
          },
          {
            "starts_at_time": "09:00:00",
            "climate_preset_key": "work"
          },
          {
            "starts_at_time": "18:00:00",
            "climate_preset_key": "home"
          },
          {
            "starts_at_time": "22:00:00",
            "climate_preset_key": "sleep"
          }
        ],
        "workspace_id": "9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab",
        "created_at": "2025-05-30T04:01:25.455Z"
      },
      {
        "thermostat_daily_program_id": "d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90",
        "device_id": "a1b2c3d4-e5f6-7890-1234-56789abcdef0",
        "name": "Weekend Program",
        "periods": [
          {
            "starts_at_time": "00:00:00",
            "climate_preset_key": "sleep"
          },
          {
            "starts_at_time": "08:00:00",
            "climate_preset_key": "home"
          },
          {
            "starts_at_time": "23:00:00",
            "climate_preset_key": "sleep"
          }
        ],
        "workspace_id": "9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab",
        "created_at": "2025-05-30T04:02:19.952Z"
      }
    ],
    "thermostat_weekly_program": null
  },
  "warnings": [],
  "workspace_id": "9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab"
}

Properties

Boolean

Indicates whether the lock supports configuring automatic locking.

Boolean

Indicates whether the thermostat supports cooling.

Boolean

Indicates whether the thermostat supports heating.

Boolean

Indicates whether the thermostat supports simultaneous heating and cooling.

Boolean

Indicates whether the device supports programming offline access codes.

Boolean

Indicates whether the device supports programming online access codes.

Boolean

Indicates whether the thermostat supports different climate programs for each day of the week.

Boolean

Indicates whether the thermostat supports a single climate program applied to every day.

Boolean

Indicates whether the thermostat supports weekday/weekend climate programs.

Boolean

Indicates whether the device supports remote locking.

Boolean

Indicates whether the device supports remote unlocking.

Boolean

Indicates whether the thermostat supports running climate programs.

Boolean

Indicates whether the device supports simulating connection in a sandbox.

Boolean

Indicates whether the device supports simulating disconnection in a sandbox.

Boolean

Indicates whether the hub supports simulating connection in a sandbox.

Boolean

Indicates whether the hub supports simulating disconnection in a sandbox.

Boolean

Indicates whether the device supports simulating a paid subscription in a sandbox.

Boolean

Indicates whether the device supports simulating removal in a sandbox.

Boolean

Indicates whether the thermostat can be turned off.

Boolean

Indicates whether the lock supports unlocking with an access code.

Array

Collection of capabilities that the device supports when connected to Seam. Values are access_code, which indicates that the device can manage and utilize digital PIN codes for secure access; lock, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; noise_detection, which indicates that the device supports monitoring and responding to ambient noise levels; thermostat, which indicates that the device can regulate and adjust indoor temperatures; battery, which indicates that the device can manage battery life and health; and phone, which indicates that the device is a mobile device, such as a smartphone. Important: Superseded by capability flags.

String (UUID)

Unique identifier for the account associated with the device.

String (ISO 8601)

Date and time at which the device object was created.

Object

Set of key:value pairs. Adding custom metadata to a resource, such as a Connect Webview, connected account, or device, enables you to store custom information, like customer details or internal IDs from your application.

String (UUID)

ID of the device.

Enum (String)

Type of the device.

String

Display name of the device, defaults to nickname (if it is set) or properties.appearance.name, otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.

Array

Array of errors associated with the device. Each error object within the array contains two fields: error_code and message. error_code is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. message provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.

Boolean

Indicates whether Seam manages the device. See also Managed and Unmanaged Devices.

String

Optional nickname to describe the device, settable through Seam.

Object

Properties of the device.

Show properties

Object

Accessory keypad properties and state.

Show properties

Object

Keypad battery properties.

Show properties

number

The level.

Boolean

Indicates if an accessory keypad is connected to the device.

Object

Appearance-related properties, as reported by the device.

Show properties

String

Name of the device as seen from the provider API and application, not settable through Seam.

Object

Represents the current status of the battery charge level.

Show properties

number

Battery charge level as a value between 0 and 1, inclusive.

Enum (String)

Represents the current status of the battery charge level. Values are critical, which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; low, which signifies that the battery is under the preferred threshold and should be charged soon; good, which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and full, which represents a battery that is fully charged, providing the maximum duration of usage.

number

Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.

Array

Array of noise threshold IDs that are currently triggering.

Boolean

Indicates whether the device has direct power.

String

Alt text for the device image.

String

Image URL for the device.

String

Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub.

Object

Device model-related properties.

Show properties

Boolean

deprecated

Deprecated. use device.properties.model.can_connect_accessory_keypadThe accessory keypad supported.

Boolean

Indicates whether the device can connect a accessory keypad.

String

Display name of the device model.

Boolean

Indicates whether the device has a built in accessory keypad.

String

Display name that corresponds to the manufacturer-specific terminology for the device.

Boolean

deprecated

Deprecated. use device.can_program_offline_access_codes.The offline access codes supported.

Boolean

deprecated

Deprecated. use device.can_program_online_access_codes.The online access codes supported.

String

deprecated

Deprecated. use device.display_name insteadName of the device.

number

Indicates current noise level in decibels, if the device supports noise detection.

Boolean

deprecated

Deprecated. use device.can_program_offline_access_codesIndicates whether it is currently possible to use offline access codes for the device.

Boolean

Indicates whether the device is online.

Boolean

deprecated

Deprecated. use device.can_program_online_access_codesIndicates whether it is currently possible to use online access codes for the device.

String

Serial number of the device.

Boolean

deprecated

Deprecated. use device.properties.model.can_connect_accessory_keypadThe supports accessory keypad.

Boolean

deprecated

Deprecated. use offline_access_codes_enabledThe supports offline access codes.

Object

ASSA ABLOY Credential Service metadata for the phone.

Show properties

Array

Endpoints associated with the phone.

Show properties

String

ID of the associated endpoint.

Boolean

Indicated whether the endpoint is active.

Boolean

Indicates whether the credential service has active endpoints associated with the phone.

Object

Salto Space credential service metadata for the phone.

Show properties

Boolean

Indicates whether the credential service has an active associated phone.

Object

Metadata for an Akiles device.

Show properties

String

Group ID to which to add users for an Akiles device.

String

Gadget ID for an Akiles device.

String

Gadget name for an Akiles device.

String

Product name for an Akiles device.

Object

Metadata for an Aqara device.

Show properties

String

Device name for an Aqara device.

String

Device ID (did) for an Aqara device.

String

Firmware version for an Aqara device.

String

Model identifier for an Aqara device.

number

Model type for an Aqara device.

String

Parent gateway device ID for an Aqara device.

String

Position (room) ID for an Aqara device.

String

Time zone reported for an Aqara device (e.g. GMT-07:00).

Object

Metadata for an ASSA ABLOY Vostio system.

Show properties

String

Encoder name for an ASSA ABLOY Vostio system.

Object

Metadata for an August device.

Show properties

Boolean

Indicates whether an August device has a keypad.

String

House ID for an August device.

String

House name for an August device.

String

Keypad battery level for an August device.

String

Lock ID for an August device.

String

Lock name for an August device.

String

Model for an August device.

Object

Metadata for an Avigilon Alta system.

Show properties

String

Entry name for an Avigilon Alta system.

number

Total count of entry relays for an Avigilon Alta system.

String

Organization name for an Avigilon Alta system.

number

Site ID for an Avigilon Alta system.

String

Site name for an Avigilon Alta system.

number

Zone ID for an Avigilon Alta system.

String

Zone name for an Avigilon Alta system.

Object

Metadata for a Brivo device.

Show properties

Boolean

Indicates whether the Brivo access point has activation (remote unlock) enabled.

String

Device name for a Brivo device.

Object

Metadata for a ControlByWeb device.

Show properties

String

Device ID for a ControlByWeb device.

String

Device name for a ControlByWeb device.

String

Relay name for a ControlByWeb device.

Object

Metadata for a dormakaba Oracode device.

Show properties

String

Device ID for a dormakaba Oracode device.

number

Door ID for a dormakaba Oracode device.

Boolean

Indicates whether a door is wireless for a dormakaba Oracode device.

String

Door name for a dormakaba Oracode device.

String

IANA time zone for a dormakaba Oracode device.

Array

Predefined time slots for a dormakaba Oracode device.

Show properties

String

Check in time for a time slot for a dormakaba Oracode device.

String

Checkout time for a time slot for a dormakaba Oracode device.

String (UUID)

ID of a user level for a dormakaba Oracode device.

number

Prefix for a user level for a dormakaba Oracode device.

Boolean

Indicates whether a time slot for a dormakaba Oracode device is a 24-hour time slot.

Boolean

Indicates whether a time slot for a dormakaba Oracode device is in biweekly mode.

Boolean

Indicates whether a time slot for a dormakaba Oracode device is a master time slot.

Boolean

Indicates whether a time slot for a dormakaba Oracode device is a one-shot time slot.

String

Name of a time slot for a dormakaba Oracode device.

number

Prefix for a time slot for a dormakaba Oracode device.

number

deprecated

Deprecated. Previously marked as “@DEPRECATED.”Site ID for a dormakaba Oracode device.

String

Site name for a dormakaba Oracode device.

Object

Metadata for an ecobee device.

Show properties

String

Device name for an ecobee device.

String

Device ID for an ecobee device.

Object

Metadata for a 4SUITES device.

Show properties

number

Device ID for a 4SUITES device.

String

Device name for a 4SUITES device.

number

Reclose delay, in seconds, for a 4SUITES device.

Object

Metadata for a Genie device.

Show properties

String

Lock name for a Genie device.

String

Door name for a Genie device.

Object

Metadata for a Honeywell Resideo device.

Show properties

String

Device name for a Honeywell Resideo device.

String

Device ID for a Honeywell Resideo device.

Object

Metadata for an igloo device.

Show properties

String

Bridge ID for an igloo device.

String

Device ID for an igloo device.

String

Model for an igloo device.

Object

Metadata for an igloohome device.

Show properties

String

Bridge ID for an igloohome device.

String

Bridge name for an igloohome device.

String

Device ID for an igloohome device.

String

Device name for an igloohome device.

Boolean

Indicates whether a keypad is linked to a bridge for an igloohome device.

String

Keypad ID for an igloohome device.

Object

Metadata for a KeyNest device.

Show properties

String

Address for a KeyNest device.

number

Current or last store ID for a KeyNest device.

String

Current status for a KeyNest device.

String

Current user company for a KeyNest device.

String

Current user email for a KeyNest device.

String

Current user name for a KeyNest device.

String

Current user phone number for a KeyNest device.

number

Default office ID for a KeyNest device.

String

Device name for a KeyNest device.

number

Fob ID for a KeyNest device.

String

Handover method for a KeyNest device.

Boolean

Whether the KeyNest device has a photo.

Boolean

Whether the key is in a locker that does not support the access codes API.

String

Key ID for a KeyNest device.

String

Key notes for a KeyNest device.

String

KeyNest app user for a KeyNest device.

String

Last movement timestamp for a KeyNest device.

String

Property ID for a KeyNest device.

String

Property postcode for a KeyNest device.

String

Status type for a KeyNest device.

String

Subscription plan for a KeyNest device.

Object

Metadata for a Kisi device.

Show properties

String

Description for a Kisi device.

number

Lock ID for a Kisi device.

String

Lock name for a Kisi device.

String

Place name for a Kisi device.

Object

Metadata for a Korelock device.

Show properties

String

Device ID for a Korelock device.

String

Device name for a Korelock device.

String

Firmware version for a Korelock device.

String

Location ID for a Korelock device. Required for timebound access codes.

String

Model code for a Korelock device.

String

Serial number for a Korelock device.

number

WiFi signal strength (0-1) for a Korelock device.

Object

Metadata for a Kwikset device.

Show properties

String

Device ID for a Kwikset device.

String

Device name for a Kwikset device.

String

Model number for a Kwikset device.

Object

Metadata for a Lockly device.

Show properties

String

Device ID for a Lockly device.

String

Device name for a Lockly device.

String

Model for a Lockly device.

Object

Metadata for a Minut device.

Show properties

String

Device ID for a Minut device.

String

Device name for a Minut device.

Object

Latest sensor values for a Minut device.

Show properties

Object

Latest accelerometer Z-axis reading for a Minut device.

Show properties

String

Time of latest accelerometer Z-axis reading for a Minut device.

number

Value of latest accelerometer Z-axis reading for a Minut device.

Object

Latest humidity reading for a Minut device.

Show properties

String

Time of latest humidity reading for a Minut device.

number

Value of latest humidity reading for a Minut device.

Object

Latest pressure reading for a Minut device.

Show properties

String

Time of latest pressure reading for a Minut device.

number

Value of latest pressure reading for a Minut device.

Object

Latest sound reading for a Minut device.

Show properties

String

Time of latest sound reading for a Minut device.

number

Value of latest sound reading for a Minut device.

Object

Latest temperature reading for a Minut device.

Show properties

String

Time of latest temperature reading for a Minut device.

number

Value of latest temperature reading for a Minut device.

Object

Metadata for a Google Nest device.

Show properties

String

Custom device name for a Google Nest device. The device owner sets this value.

String

Device name for a Google Nest device. Google sets this value.

String

Display name for a Google Nest device.

String

Device ID for a Google Nest device.

String

ID of the Google Nest structure containing the device.

String

Name of the Google Nest structure containing the device. The device owner sets this value.

Object

Metadata for a NoiseAware device.

Show properties

String

Device ID for a NoiseAware device.

Enum (String)

Device model for a NoiseAware device.

String

Device name for a NoiseAware device.

number

Noise level, in decibels, for a NoiseAware device.

number

Noise level, expressed as a Noise Risk Score (NRS), for a NoiseAware device.

Object

Metadata for a Nuki device.

Show properties

String

Device ID for a Nuki device.

String

Device name for a Nuki device.

Boolean

Indicates whether keypad 2 is paired for a Nuki device.

Boolean

Indicates whether the keypad battery is in a critical state for a Nuki device.

Boolean

Indicates whether the keypad is paired for a Nuki device.

Object

Metadata for an Omnitec device.

Show properties

Boolean

Whether the Omnitec lock has a connected gateway for remote operations.

String

Operator-assigned alias for an Omnitec device.

number

Lock ID for an Omnitec device.

String

Bluetooth MAC address for an Omnitec device.

String

Lock name for an Omnitec device.

String

IANA time zone for the Omnitec device, used to schedule time-bound access codes at the correct local time (accounting for DST).

number

Static UTC offset of the Omnitec lock in milliseconds. Does not account for DST.

Object

Metadata for a Ring device.

Show properties

String

Device ID for a Ring device.

String

Device name for a Ring device.

Object

Metadata for a Salto KS device.

Show properties

String

Battery level for a Salto KS device.

String

Customer reference for a Salto KS device.

Boolean

Indicates whether the site has a Salto KS subscription that supports custom PINs.

String

Lock ID for a Salto KS device.

String

Lock type for a Salto KS device.

String

Locked state for a Salto KS device.

String

Model for a Salto KS device.

String

Site ID for the Salto KS site to which the device belongs.

String

Site name for the Salto KS site to which the device belongs.

Object

deprecated

Deprecated. Use salto_ks_metadata instead.Metada for a Salto device.

Show properties

String

Battery level for a Salto device.

String

Customer reference for a Salto device.

String

Lock ID for a Salto device.

String

Lock type for a Salto device.

String

Locked state for a Salto device.

String

Model for a Salto device.

String

Site ID for the Salto KS site to which the device belongs.

String

Site name for the Salto KS site to which the device belongs.

Object

Metadata for a Schlage device.

Show properties

String

Device ID for a Schlage device.

String

Device name for a Schlage device.

String

Model for a Schlage device.

Object

Metadata for Seam Bridge.

Show properties

number

Device number for Seam Bridge.

String

Name for Seam Bridge.

Enum (String)

Unlock method for Seam Bridge.

Object

Metadata for a Sensi device.

Show properties

String

Device ID for a Sensi device.

String

Device name for a Sensi device.

Boolean

Set to true when the device does not support the /dual-setpoints API endpoint.

Array

Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error.

String

Product type for a Sensi device.

Object

Metadata for a SmartThings device.

Show properties

String

Device ID for a SmartThings device.

String

Device name for a SmartThings device.

String

Location ID for a SmartThings device.

String

Model for a SmartThings device.

Object

Metadata for a tado° device.

Show properties

String

Device type for a tado° device.

String

Serial number for a tado° device.

Object

Metadata for a Tedee device.

Show properties

number

Bridge ID for a Tedee device.

String

Bridge name for a Tedee device.

number

Device ID for a Tedee device.

String

Device model for a Tedee device.

String

Device name for a Tedee device.

number

Keypad ID for a Tedee device.

String

Serial number for a Tedee device.

Object

Metadata for a TTLock device.

Show properties

String

Feature value for a TTLock device.

Object

Features for a TTLock device.

Show properties

Boolean

Indicates whether a TTLock device supports auto-lock time configuration.

Boolean

Indicates whether a TTLock device supports an incomplete keyboard passcode.

Boolean

Indicates whether a TTLock device supports the lock command.

Boolean

Indicates whether a TTLock device supports a passcode.

Boolean

Indicates whether a TTLock device supports passcode management.

Boolean

Indicates whether a TTLock device supports unlock via gateway.

Boolean

Indicates whether a TTLock device supports Wi-Fi.

Boolean

Indicates whether a TTLock device has a gateway.

String

Lock alias for a TTLock device.

number

Lock ID for a TTLock device.

number

Lock-side timezone offset in milliseconds east of UTC, as configured in the TTLock app. Source of truth for the lock’s wall-clock interpretation of access code start/end times — a misconfigured value here is the typical cause of customer “codes offset by N hours” reports. Diagnostic only; Seam does not convert times based on this value.

Array

Wireless keypads for a TTLock device.

Show properties

number

ID for a wireless keypad for a TTLock device.

String

Name for a wireless keypad for a TTLock device.

Object

Metadata for a 2N device.

Show properties

number

Device ID for a 2N device.

String

Device name for a 2N device.

Object

Metadata for an Ultraloq device.

Show properties

String

Device ID for an Ultraloq device.

String

Device name for an Ultraloq device.

String

Device type for an Ultraloq device.

String

IANA timezone for the Ultraloq device.

Object

Metadata for an ASSA ABLOY Visionline system.

Show properties

String

Encoder ID for an ASSA ABLOY Visionline system.

Object

Metadata for a Wyze device.

Show properties

String

Device ID for a Wyze device.

String

Device information model for a Wyze device.

String

Device name for a Wyze device.

String

Keypad UUID for a Wyze device.

number

Locker status (hardlock) for a Wyze device.

String

Product model for a Wyze device.

String

Product name for a Wyze device.

String

Product type for a Wyze device.

number

The delay in seconds before the lock automatically locks after being unlocked.

Boolean

Indicates whether automatic locking is enabled.

Boolean

Indicates whether the backup access code pool is currently enabled for the device. To disable it, set this to false using /devices/update.

Array

Constraints on access codes for the device. Seam represents each constraint as an object with a constraint_type property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific.

Show properties

Enum (String)

The constraint type.

number

Maximum name length constraint for access codes.

number

Minimum name length constraint for access codes.

Boolean

Indicates whether the door is open.

Boolean

Indicates whether the device supports native entry events.

Object

Keypad battery status.

Show properties

number

Keypad battery charge level.

Boolean

Indicates whether the lock is locked.

number

Maximum number of active access codes that the device supports.

Array

Time frames that may be requested when creating an offline access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options’ duration ranges do not overlap, or by display_name when they do) and satisfies that one option’s rules. When undefined, any time frame works.

Show properties

String

Label for this option. For a single-option device, the product name (for example, algoPIN or SmartPIN); for a multi-option device, a label that distinguishes it (for example, Hourly or Fixed start times).

String

iCalendar recurrence rule (RRULE) that the end date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules.

Boolean

When true, the start and end must fall at the same time of day (the caller picks which). Mutually exclusive with time_pairs.

String

Maximum duration this option covers, as an ISO 8601 duration (for example, PT672H or P367D). Omitted when there is no maximum.

String

Minimum duration this option covers, as an ISO 8601 duration (for example, PT1H or P29D). Omitted when there is no minimum.

String

iCalendar recurrence rule (RRULE) that the start date must fall on (for example, FREQ=MONTHLY;BYDAY=1MO,3MO). Constrains which calendar dates are selectable, independent of the time-of-day rules.

Array

Fixed start/end time pairings the caller chooses from. Mutually exclusive with matching_start_end_time.

Show properties

String

Label for the start/end time pairing.

String

End time of day as a 24-hour HH:MM value, interpreted in the option’s time_zone. An end_time earlier on the clock than start_time means the end falls on a later date.

String

Start time of day as a 24-hour HH:MM value, interpreted in the option’s time_zone.

String

IANA time zone for interpreting time_pairs and the date recurrence rules. Present only when the option fixes times or dates.

Array

Time frames that may be requested when creating an online access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options’ duration ranges do not overlap, or by display_name when they do) and satisfies that one option’s rules. When undefined, any time frame works.

Show properties

String

iCalendar recurrence rule (RRULE) that the end date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules.

Boolean

When true, the start and end must fall at the same time of day (the caller picks which). Mutually exclusive with time_pairs.

String

Maximum duration this option covers, as an ISO 8601 duration (for example, PT672H or P367D). Omitted when there is no maximum.

String

Minimum duration this option covers, as an ISO 8601 duration (for example, PT1H or P29D). Omitted when there is no minimum.

String

iCalendar recurrence rule (RRULE) that the start date must fall on (for example, FREQ=MONTHLY;BYDAY=1MO,3MO). Constrains which calendar dates are selectable, independent of the time-of-day rules.

Array

Fixed start/end time pairings the caller chooses from. Mutually exclusive with matching_start_end_time.

Show properties

String

Label for the start/end time pairing.

String

End time of day as a 24-hour HH:MM value, interpreted in the option’s time_zone. An end_time earlier on the clock than start_time means the end falls on a later date.

String

Start time of day as a 24-hour HH:MM value, interpreted in the option’s time_zone.

String

IANA time zone for interpreting time_pairs and the date recurrence rules. Present only when the option fixes times or dates.

Array

Supported code lengths for access codes.

Boolean

Indicates whether the device supports a backup access code pool.

Object

deprecated

Deprecated. Use active_thermostat_schedule_id with /thermostats/schedules/get instead.Active thermostat schedule.

Show properties

String

Key of the climate preset to use for the thermostat schedule.

String (ISO 8601)

Date and time at which the thermostat schedule was created.

String (UUID)

ID of the desired thermostat device.

String (ISO 8601)

Date and time at which the thermostat schedule ends, in ISO 8601 format.

Array

Errors associated with the thermostat schedule.

Show properties

String (ISO 8601)

Date and time at which Seam created the error.

String

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

Boolean

Indicates whether a person at the thermostat can change the thermostat’s settings after the thermostat schedule starts.

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.

String

User-friendly name to identify the thermostat schedule.

String (ISO 8601)

Date and time at which the thermostat schedule starts, in ISO 8601 format.

String (UUID)

ID of the thermostat schedule.

String (UUID)

ID of the workspace that contains the thermostat schedule.

String (UUID)

ID of the active thermostat schedule.

Array

Climate preset modes that the thermostat supports, such as “home”, “away”, “wake”, “sleep”, “occupied”, and “unoccupied”.

Array

Available climate presets for the thermostat.

Show properties

Boolean

Indicates whether the climate preset key can be deleted.

Boolean

Indicates whether the climate preset key can be edited.

Boolean

Indicates whether the climate preset key can be programmed in a thermostat daily program.

String

Unique key to identify the climate preset.

Enum (String)

The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.

number

Temperature to which the thermostat should cool (in °C). See also Set Points.

number

Temperature to which the thermostat should cool (in °F). See also Set Points.

String

Display name for the climate preset.

Object

Metadata specific to the Ecobee climate, if applicable.

Show properties

String

Reference to the Ecobee climate, if applicable.

Boolean

Indicates if the climate preset is optimized by Ecobee.

Enum (String)

Indicates whether the climate preset is owned by the user or the system.

Enum (String)

Desired fan mode setting, such as on, auto, or circulate.

number

Temperature to which the thermostat should heat (in °C). See also Set Points.

number

Temperature to which the thermostat should heat (in °F). See also Set Points.

Enum (String)

Desired HVAC mode setting, such as heat, cool, heat_cool, or off.

Boolean

deprecated

Deprecated. Use ‘thermostat_schedule.is_override_allowed’Indicates whether a person at the thermostat can change the thermostat’s settings. See Specifying Manual Override Permissions.

String

User-friendly name to identify the climate preset.

Array

Fan mode settings that the thermostat supports.

Array

HVAC mode settings that the thermostat supports.

Object

Current climate setting.

Show properties

Boolean

Indicates whether the climate preset key can be deleted.

Boolean

Indicates whether the climate preset key can be edited.

Boolean

Indicates whether the climate preset key can be programmed in a thermostat daily program.

String

Unique key to identify the climate preset.

Enum (String)

The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.

number

Temperature to which the thermostat should cool (in °C). See also Set Points.

number

Temperature to which the thermostat should cool (in °F). See also Set Points.

String

Display name for the climate preset.

Object

Metadata specific to the Ecobee climate, if applicable.

Show properties

String

Reference to the Ecobee climate, if applicable.

Boolean

Indicates if the climate preset is optimized by Ecobee.

Enum (String)

Indicates whether the climate preset is owned by the user or the system.

Enum (String)

Desired fan mode setting, such as on, auto, or circulate.

number

Temperature to which the thermostat should heat (in °C). See also Set Points.

number

Temperature to which the thermostat should heat (in °F). See also Set Points.

Enum (String)

Desired HVAC mode setting, such as heat, cool, heat_cool, or off.

Boolean

deprecated

Deprecated. Use ‘thermostat_schedule.is_override_allowed’Indicates whether a person at the thermostat can change the thermostat’s settings. See Specifying Manual Override Permissions.

String

User-friendly name to identify the climate preset.

Object

deprecated

Deprecated. use fallback_climate_preset_key to specify a fallback climate preset instead.The default climate setting.

Show properties

Boolean

Indicates whether the climate preset key can be deleted.

Boolean

Indicates whether the climate preset key can be edited.

Boolean

Indicates whether the climate preset key can be programmed in a thermostat daily program.

String

Unique key to identify the climate preset.

Enum (String)

The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.

number

Temperature to which the thermostat should cool (in °C). See also Set Points.

number

Temperature to which the thermostat should cool (in °F). See also Set Points.

String

Display name for the climate preset.

Object

Metadata specific to the Ecobee climate, if applicable.

Show properties

String

Reference to the Ecobee climate, if applicable.

Boolean

Indicates if the climate preset is optimized by Ecobee.

Enum (String)

Indicates whether the climate preset is owned by the user or the system.

Enum (String)

Desired fan mode setting, such as on, auto, or circulate.

number

Temperature to which the thermostat should heat (in °C). See also Set Points.

number

Temperature to which the thermostat should heat (in °F). See also Set Points.

Enum (String)

Desired HVAC mode setting, such as heat, cool, heat_cool, or off.

Boolean

deprecated

Deprecated. Use ‘thermostat_schedule.is_override_allowed’Indicates whether a person at the thermostat can change the thermostat’s settings. See Specifying Manual Override Permissions.

String

User-friendly name to identify the climate preset.

String

Key of the fallback climate preset for the thermostat.

Enum (String)

deprecated

Deprecated. Use current_climate_setting.fan_mode_setting instead.The fan mode setting.

Boolean

Indicates whether the connected HVAC system is currently cooling, as reported by the thermostat.

Boolean

Indicates whether the fan in the connected HVAC system is currently running, as reported by the thermostat.

Boolean

Indicates whether the connected HVAC system is currently heating, as reported by the thermostat.

Boolean

Indicates whether the current thermostat settings differ from the most recent active program or schedule that Seam activated. For this condition to occur, current_climate_setting.manual_override_allowed must also be true.

number

Maximum cooling set point in °C.

number

Maximum cooling set point in °F.

number

Maximum heating set point in °C.

number

Maximum heating set point in °F.

number

Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4.

number

Maximum number of climate presets that the thermostat can support for weekly programming.

number

Minimum cooling set point in °C.

number

Minimum cooling set point in °F.

number

Minimum temperature difference in °C between the cooling and heating set points when in heat-cool (auto) mode.

number

Minimum temperature difference in °F between the cooling and heating set points when in heat-cool (auto) mode.

number

Minimum heating set point in °C.

number

Minimum heating set point in °F.

number

Reported relative humidity, as a value between 0 and 1, inclusive.

number

Reported temperature in °C.

number

Reported temperature in °F.

Object

Current temperature threshold set for the thermostat.

Show properties

number

Lower limit in °C within the current temperature threshold set for the thermostat.

number

Lower limit in °F within the current temperature threshold set for the thermostat.

number

Upper limit in °C within the current temperature threshold set for the thermostat.

number

Upper limit in °F within the current temperature threshold set for the thermostat.

number

Precision of the thermostat’s period in minutes. For example, if the thermostat supports 15-minute periods, this value is 15. All values are relative to the top of the hour, so for 15 minutes, the periods would be 0, 15, 30, and 45 minutes past the hour.

Array

Configured daily programs for the thermostat.

Show properties

String (ISO 8601)

Date and time at which the thermostat daily program was created.

String (UUID)

ID of the thermostat device on which the thermostat daily program is configured.

String

User-friendly name to identify the thermostat daily program.

Array

Array of thermostat daily program periods.

Show properties

String

Key of the climate preset to activate at the starts_at_time.

String

Time at which the thermostat daily program period starts, in ISO 8601 format.

String (UUID)

ID of the thermostat daily program.

String (UUID)

ID of the workspace that contains the thermostat daily program.

Object

Current weekly program for the thermostat.

Show properties

String (ISO 8601)

Date and time at which the thermostat weekly program was created.

String (UUID)

ID of the thermostat daily program to run on Fridays.

String (UUID)

ID of the thermostat daily program to run on Mondays.

String (UUID)

ID of the thermostat daily program to run on Saturdays.

String (UUID)

ID of the thermostat daily program to run on Sundays.

String (UUID)

ID of the thermostat daily program to run on Thursdays.

String (UUID)

ID of the thermostat daily program to run on Tuesdays.

String (UUID)

ID of the thermostat daily program to run on Wednesdays.

Array

IDs of the spaces the device is in.

Array

Array of warnings associated with the device. Each warning object within the array contains two fields: warning_code and message. warning_code is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. message provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.

String (UUID)

Unique identifier for the Seam workspace associated with the device.

Thermostats

Object

deprecated

Deprecated. Use active_thermostat_schedule_id with /thermostats/schedules/get instead.Active thermostat schedule.

Show properties

String

Key of the climate preset to use for the thermostat schedule.

String (ISO 8601)

Date and time at which the thermostat schedule was created.

String (UUID)

ID of the desired thermostat device.

String (ISO 8601)

Date and time at which the thermostat schedule ends, in ISO 8601 format.

Array

Errors associated with the thermostat schedule.

Show properties

String (ISO 8601)

Date and time at which Seam created the error.

String

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

Boolean

Indicates whether a person at the thermostat can change the thermostat’s settings after the thermostat schedule starts.

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.

String

User-friendly name to identify the thermostat schedule.

String (ISO 8601)

Date and time at which the thermostat schedule starts, in ISO 8601 format.

String (UUID)

ID of the thermostat schedule.

String (UUID)

ID of the workspace that contains the thermostat schedule.

String (UUID)

ID of the active thermostat schedule.

Array

Climate preset modes that the thermostat supports, such as “home”, “away”, “wake”, “sleep”, “occupied”, and “unoccupied”.

Array

Available climate presets for the thermostat.

Show properties

Boolean

Indicates whether the climate preset key can be deleted.

Boolean

Indicates whether the climate preset key can be edited.

Boolean

Indicates whether the climate preset key can be programmed in a thermostat daily program.

String

Unique key to identify the climate preset.

Enum (String)

The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.

number

Temperature to which the thermostat should cool (in °C). See also Set Points.

number

Temperature to which the thermostat should cool (in °F). See also Set Points.

String

Display name for the climate preset.

Object

Metadata specific to the Ecobee climate, if applicable.

Show properties

String

Reference to the Ecobee climate, if applicable.

Boolean

Indicates if the climate preset is optimized by Ecobee.

Enum (String)

Indicates whether the climate preset is owned by the user or the system.

Enum (String)

Desired fan mode setting, such as on, auto, or circulate.

number

Temperature to which the thermostat should heat (in °C). See also Set Points.

number

Temperature to which the thermostat should heat (in °F). See also Set Points.

Enum (String)

Desired HVAC mode setting, such as heat, cool, heat_cool, or off.

Boolean

deprecated

Deprecated. Use ‘thermostat_schedule.is_override_allowed’Indicates whether a person at the thermostat can change the thermostat’s settings. See Specifying Manual Override Permissions.

String

User-friendly name to identify the climate preset.

Array

Fan mode settings that the thermostat supports.

Array

HVAC mode settings that the thermostat supports.

Object

Current climate setting.

Show properties

Boolean

Indicates whether the climate preset key can be deleted.

Boolean

Indicates whether the climate preset key can be edited.

Boolean

Indicates whether the climate preset key can be programmed in a thermostat daily program.

String

Unique key to identify the climate preset.

Enum (String)

The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.

number

Temperature to which the thermostat should cool (in °C). See also Set Points.

number

Temperature to which the thermostat should cool (in °F). See also Set Points.

String

Display name for the climate preset.

Object

Metadata specific to the Ecobee climate, if applicable.

Show properties

String

Reference to the Ecobee climate, if applicable.

Boolean

Indicates if the climate preset is optimized by Ecobee.

Enum (String)

Indicates whether the climate preset is owned by the user or the system.

Enum (String)

Desired fan mode setting, such as on, auto, or circulate.

number

Temperature to which the thermostat should heat (in °C). See also Set Points.

number

Temperature to which the thermostat should heat (in °F). See also Set Points.

Enum (String)

Desired HVAC mode setting, such as heat, cool, heat_cool, or off.

Boolean

deprecated

Deprecated. Use ‘thermostat_schedule.is_override_allowed’Indicates whether a person at the thermostat can change the thermostat’s settings. See Specifying Manual Override Permissions.

String

User-friendly name to identify the climate preset.

Object

deprecated

Deprecated. use fallback_climate_preset_key to specify a fallback climate preset instead.The default climate setting.

Show properties

Boolean

Indicates whether the climate preset key can be deleted.

Boolean

Indicates whether the climate preset key can be edited.

Boolean

Indicates whether the climate preset key can be programmed in a thermostat daily program.

String

Unique key to identify the climate preset.

Enum (String)

The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.

number

Temperature to which the thermostat should cool (in °C). See also Set Points.

number

Temperature to which the thermostat should cool (in °F). See also Set Points.

String

Display name for the climate preset.

Object

Metadata specific to the Ecobee climate, if applicable.

Show properties

String

Reference to the Ecobee climate, if applicable.

Boolean

Indicates if the climate preset is optimized by Ecobee.

Enum (String)

Indicates whether the climate preset is owned by the user or the system.

Enum (String)

Desired fan mode setting, such as on, auto, or circulate.

number

Temperature to which the thermostat should heat (in °C). See also Set Points.

number

Temperature to which the thermostat should heat (in °F). See also Set Points.

Enum (String)

Desired HVAC mode setting, such as heat, cool, heat_cool, or off.

Boolean

deprecated

Deprecated. Use ‘thermostat_schedule.is_override_allowed’Indicates whether a person at the thermostat can change the thermostat’s settings. See Specifying Manual Override Permissions.

String

User-friendly name to identify the climate preset.

String

Key of the fallback climate preset for the thermostat.

Enum (String)

deprecated

Deprecated. Use current_climate_setting.fan_mode_setting instead.The fan mode setting.

Boolean

Indicates whether the connected HVAC system is currently cooling, as reported by the thermostat.

Boolean

Indicates whether the fan in the connected HVAC system is currently running, as reported by the thermostat.

Boolean

Indicates whether the connected HVAC system is currently heating, as reported by the thermostat.

Boolean

number

Maximum cooling set point in °C.

number

Maximum cooling set point in °F.

number

Maximum heating set point in °C.

number

Maximum heating set point in °F.

number

Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4.

number

Maximum number of climate presets that the thermostat can support for weekly programming.

number

Minimum cooling set point in °C.

number

Minimum cooling set point in °F.

number

Minimum temperature difference in °C between the cooling and heating set points when in heat-cool (auto) mode.

number

Minimum temperature difference in °F between the cooling and heating set points when in heat-cool (auto) mode.

number

Minimum heating set point in °C.

number

Minimum heating set point in °F.

number

Reported relative humidity, as a value between 0 and 1, inclusive.

number

Reported temperature in °C.

number

Reported temperature in °F.

Object

Current temperature threshold set for the thermostat.

Show properties

number

Lower limit in °C within the current temperature threshold set for the thermostat.

number

Lower limit in °F within the current temperature threshold set for the thermostat.

number

Upper limit in °C within the current temperature threshold set for the thermostat.

number

Upper limit in °F within the current temperature threshold set for the thermostat.

number

Array

Configured daily programs for the thermostat.

Show properties

String (ISO 8601)

Date and time at which the thermostat daily program was created.

String (UUID)

ID of the thermostat device on which the thermostat daily program is configured.

String

User-friendly name to identify the thermostat daily program.

Array

Array of thermostat daily program periods.

Show properties

String

Key of the climate preset to activate at the starts_at_time.

String

Time at which the thermostat daily program period starts, in ISO 8601 format.

String (UUID)

ID of the thermostat daily program.

String (UUID)

ID of the workspace that contains the thermostat daily program.

Object

Current weekly program for the thermostat.

Show properties

String (ISO 8601)

Date and time at which the thermostat weekly program was created.

String (UUID)

ID of the thermostat daily program to run on Fridays.

String (UUID)

ID of the thermostat daily program to run on Mondays.

String (UUID)

ID of the thermostat daily program to run on Saturdays.

String (UUID)

ID of the thermostat daily program to run on Sundays.

String (UUID)

ID of the thermostat daily program to run on Thursdays.

String (UUID)

ID of the thermostat daily program to run on Tuesdays.

String (UUID)

ID of the thermostat daily program to run on Wednesdays.

Getting Started

Granting Access

Devices and Systems

Setup

Monitoring

Low-Level APIs

The Thermostat Object

The device Object for Thermostats

Properties

Thermostats

​The device Object for Thermostats

​Properties

​Thermostats

The device Object for Thermostats

Properties

Thermostats