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

can_configure_auto_lock

Boolean

Indicates whether the lock supports configuring automatic locking.

can_hvac_cool

Boolean

Indicates whether the thermostat supports cooling.

can_hvac_heat

Boolean

Indicates whether the thermostat supports heating.

can_hvac_heat_cool

Boolean

Indicates whether the thermostat supports simultaneous heating and cooling.

can_program_offline_access_codes

Boolean

Indicates whether the device supports programming offline access codes.

can_program_online_access_codes

Boolean

Indicates whether the device supports programming online access codes.

can_program_thermostat_programs_as_different_each_day

Boolean

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

can_program_thermostat_programs_as_same_each_day

Boolean

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

can_program_thermostat_programs_as_weekday_weekend

Boolean

Indicates whether the thermostat supports weekday/weekend climate programs.

can_remotely_lock

Boolean

Indicates whether the device supports remote locking.

can_remotely_unlock

Boolean

Indicates whether the device supports remote unlocking.

can_run_thermostat_programs

Boolean

Indicates whether the thermostat supports running climate programs.

can_simulate_connection

Boolean

Indicates whether the device supports simulating connection in a sandbox.

can_simulate_disconnection

Boolean

Indicates whether the device supports simulating disconnection in a sandbox.

can_simulate_hub_connection

Boolean

Indicates whether the hub supports simulating connection in a sandbox.

can_simulate_hub_disconnection

Boolean

Indicates whether the hub supports simulating disconnection in a sandbox.

can_simulate_paid_subscription

Boolean

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

can_simulate_removal

Boolean

Indicates whether the device supports simulating removal in a sandbox.

can_turn_off_hvac

Boolean

Indicates whether the thermostat can be turned off.

can_unlock_with_code

Boolean

Indicates whether the lock supports unlocking with an access code.

capabilities_supported

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.

connected_account_id

String (UUID)

Unique identifier for the account associated with the device.

created_at

String (ISO 8601)

Date and time at which the device object was created.

custom_metadata

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.

device_id

String (UUID)

ID of the device.

device_type

Enum (String)

Type of the device.

display_name

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.

errors

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.

is_managed

Boolean

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

nickname

String

Optional nickname to describe the device, settable through Seam.

properties

Object

Properties of the device.

Show properties

accessory_keypad

Object

Accessory keypad properties and state.

Show properties

battery

Object

Keypad battery properties.

Show properties

level

number

The level.

is_connected

Boolean

Indicates if an accessory keypad is connected to the device.

appearance

Object

Appearance-related properties, as reported by the device.

Show properties

name

String

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

battery

Object

Represents the current status of the battery charge level.

Show properties

level

number

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

status

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.

battery_level

number

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

currently_triggering_noise_threshold_ids

Array

Array of noise threshold IDs that are currently triggering.

has_direct_power

Boolean

Indicates whether the device has direct power.

image_alt_text

String

Alt text for the device image.

image_url

String

Image URL for the device.

manufacturer

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.

model

Object

Device model-related properties.

Show properties

accessory_keypad_supported

Boolean

deprecated

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

can_connect_accessory_keypad

Boolean

Indicates whether the device can connect a accessory keypad.

display_name

String

Display name of the device model.

has_built_in_keypad

Boolean

Indicates whether the device has a built in accessory keypad.

manufacturer_display_name

String

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

offline_access_codes_supported

Boolean

deprecated

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

online_access_codes_supported

Boolean

deprecated

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

name

String

deprecated

Deprecated. use device.display_name insteadName of the device.

noise_level_decibels

number

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

offline_access_codes_enabled

Boolean

deprecated

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

online

Boolean

Indicates whether the device is online.

online_access_codes_enabled

Boolean

deprecated

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

serial_number

String

Serial number of the device.

supports_accessory_keypad

Boolean

deprecated

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

supports_offline_access_codes

Boolean

deprecated

Deprecated. use offline_access_codes_enabledThe supports offline access codes.

assa_abloy_credential_service_metadata

Object

ASSA ABLOY Credential Service metadata for the phone.

Show properties

endpoints

Array

Endpoints associated with the phone.

Show properties

endpoint_id

String

ID of the associated endpoint.

is_active

Boolean

Indicated whether the endpoint is active.

has_active_endpoint

Boolean

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

salto_space_credential_service_metadata

Object

Salto Space credential service metadata for the phone.

Show properties

has_active_phone

Boolean

Indicates whether the credential service has an active associated phone.

akiles_metadata

Object

Metadata for an Akiles device.

Show properties

_member_group_id

String

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

gadget_id

String

Gadget ID for an Akiles device.

gadget_name

String

Gadget name for an Akiles device.

product_name

String

Product name for an Akiles device.

assa_abloy_vostio_metadata

Object

Metadata for an ASSA ABLOY Vostio system.

Show properties

encoder_name

String

Encoder name for an ASSA ABLOY Vostio system.

august_metadata

Object

Metadata for an August device.

Show properties

has_keypad

Boolean

Indicates whether an August device has a keypad.

house_id

String

House ID for an August device.

house_name

String

House name for an August device.

keypad_battery_level

String

Keypad battery level for an August device.

lock_id

String

Lock ID for an August device.

lock_name

String

Lock name for an August device.

model

String

Model for an August device.

avigilon_alta_metadata

Object

Metadata for an Avigilon Alta system.

Show properties

entry_name

String

Entry name for an Avigilon Alta system.

entry_relays_total_count

number

Total count of entry relays for an Avigilon Alta system.

org_name

String

Organization name for an Avigilon Alta system.

site_id

number

Site ID for an Avigilon Alta system.

site_name

String

Site name for an Avigilon Alta system.

zone_id

number

Zone ID for an Avigilon Alta system.

zone_name

String

Zone name for an Avigilon Alta system.

brivo_metadata

Object

Metadata for a Brivo device.

Show properties

activation_enabled

Boolean

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

device_name

String

Device name for a Brivo device.

controlbyweb_metadata

Object

Metadata for a ControlByWeb device.

Show properties

device_id

String

Device ID for a ControlByWeb device.

device_name

String

Device name for a ControlByWeb device.

relay_name

String

Relay name for a ControlByWeb device.

dormakaba_oracode_metadata

Object

Metadata for a dormakaba Oracode device.

Show properties

device_id

Object

Device ID for a dormakaba Oracode device.

door_id

number

Door ID for a dormakaba Oracode device.

door_is_wireless

Boolean

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

door_name

String

Door name for a dormakaba Oracode device.

iana_timezone

String

IANA time zone for a dormakaba Oracode device.

predefined_time_slots

Array

Predefined time slots for a dormakaba Oracode device.

Show properties

check_in_time

String

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

check_out_time

String

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

dormakaba_oracode_user_level_id

String (UUID)

ID of a user level for a dormakaba Oracode device.

dormakaba_oracode_user_level_prefix

number

Prefix for a user level for a dormakaba Oracode device.

is_24_hour

Boolean

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

is_biweekly_mode

Boolean

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

is_master

Boolean

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

is_one_shot

Boolean

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

name

String

Name of a time slot for a dormakaba Oracode device.

prefix

number

Prefix for a time slot for a dormakaba Oracode device.

site_id

number

deprecated

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

site_name

String

Site name for a dormakaba Oracode device.

ecobee_metadata

Object

Metadata for an ecobee device.

Show properties

device_name

String

Device name for an ecobee device.

ecobee_device_id

String

Device ID for an ecobee device.

four_suites_metadata

Object

Metadata for a 4SUITES device.

Show properties

device_id

number

Device ID for a 4SUITES device.

device_name

String

Device name for a 4SUITES device.

reclose_delay_in_seconds

number

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

genie_metadata

Object

Metadata for a Genie device.

Show properties

device_name

String

Lock name for a Genie device.

door_name

String

Door name for a Genie device.

honeywell_resideo_metadata

Object

Metadata for a Honeywell Resideo device.

Show properties

device_name

String

Device name for a Honeywell Resideo device.

honeywell_resideo_device_id

String

Device ID for a Honeywell Resideo device.

igloo_metadata

Object

Metadata for an igloo device.

Show properties

bridge_id

String

Bridge ID for an igloo device.

device_id

String

Device ID for an igloo device.

model

String

Model for an igloo device.

igloohome_metadata

Object

Metadata for an igloohome device.

Show properties

bridge_id

String

Bridge ID for an igloohome device.

bridge_name

String

Bridge name for an igloohome device.

device_id

String

Device ID for an igloohome device.

device_name

String

Device name for an igloohome device.

is_accessory_keypad_linked_to_bridge

Boolean

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

keypad_id

String

Keypad ID for an igloohome device.

keynest_metadata

Object

Metadata for a KeyNest device.

Show properties

address

String

Address for a KeyNest device.

current_or_last_store_id

number

Current or last store ID for a KeyNest device.

current_status

String

Current status for a KeyNest device.

current_user_company

String

Current user company for a KeyNest device.

current_user_email

String

Current user email for a KeyNest device.

current_user_name

String

Current user name for a KeyNest device.

current_user_phone_number

String

Current user phone number for a KeyNest device.

default_office_id

number

Default office ID for a KeyNest device.

device_name

String

Device name for a KeyNest device.

fob_id

number

Fob ID for a KeyNest device.

handover_method

String

Handover method for a KeyNest device.

has_photo

Boolean

Whether the KeyNest device has a photo.

is_quadient_locker

Boolean

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

key_id

String

Key ID for a KeyNest device.

key_notes

String

Key notes for a KeyNest device.

keynest_app_user

String

KeyNest app user for a KeyNest device.

last_movement

String

Last movement timestamp for a KeyNest device.

property_id

String

Property ID for a KeyNest device.

property_postcode

String

Property postcode for a KeyNest device.

status_type

String

Status type for a KeyNest device.

subscription_plan

String

Subscription plan for a KeyNest device.

kisi_metadata

Object

Metadata for a Kisi device.

Show properties

description

String

Description for a Kisi device.

lock_id

number

Lock ID for a Kisi device.

lock_name

String

Lock name for a Kisi device.

place_name

String

Place name for a Kisi device.

korelock_metadata

Object

Metadata for a Korelock device.

Show properties

device_id

String

Device ID for a Korelock device.

device_name

String

Device name for a Korelock device.

firmware_version

String

Firmware version for a Korelock device.

location_id

String

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

model_code

String

Model code for a Korelock device.

serial_number

String

Serial number for a Korelock device.

wifi_signal_strength

number

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

kwikset_metadata

Object

Metadata for a Kwikset device.

Show properties

device_id

String

Device ID for a Kwikset device.

device_name

String

Device name for a Kwikset device.

model_number

String

Model number for a Kwikset device.

lockly_metadata

Object

Metadata for a Lockly device.

Show properties

device_id

String

Device ID for a Lockly device.

device_name

String

Device name for a Lockly device.

model

String

Model for a Lockly device.

minut_metadata

Object

Metadata for a Minut device.

Show properties

device_id

String

Device ID for a Minut device.

device_name

String

Device name for a Minut device.

latest_sensor_values

Object

Latest sensor values for a Minut device.

Show properties

accelerometer_z

Object

Latest accelerometer Z-axis reading for a Minut device.

Show properties

time

String

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

value

number

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

humidity

Object

Latest humidity reading for a Minut device.

Show properties

time

String

Time of latest humidity reading for a Minut device.

value

number

Value of latest humidity reading for a Minut device.

pressure

Object

Latest pressure reading for a Minut device.

Show properties

time

String

Time of latest pressure reading for a Minut device.

value

number

Value of latest pressure reading for a Minut device.

sound

Object

Latest sound reading for a Minut device.

Show properties

time

String

Time of latest sound reading for a Minut device.

value

number

Value of latest sound reading for a Minut device.

temperature

Object

Latest temperature reading for a Minut device.

Show properties

time

String

Time of latest temperature reading for a Minut device.

value

number

Value of latest temperature reading for a Minut device.

nest_metadata

Object

Metadata for a Google Nest device.

Show properties

device_custom_name

String

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

device_name

String

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

display_name

String

Display name for a Google Nest device.

nest_device_id

String

Device ID for a Google Nest device.

noiseaware_metadata

Object

Metadata for a NoiseAware device.

Show properties

device_id

String

Device ID for a NoiseAware device.

device_model

Enum (String)

Device model for a NoiseAware device.

device_name

String

Device name for a NoiseAware device.

noise_level_decibel

number

Noise level, in decibels, for a NoiseAware device.

noise_level_nrs

number

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

nuki_metadata

Object

Metadata for a Nuki device.

Show properties

device_id

String

Device ID for a Nuki device.

device_name

String

Device name for a Nuki device.

keypad_2_paired

Boolean

Indicates whether keypad 2 is paired for a Nuki device.

keypad_battery_critical

Boolean

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

keypad_paired

Boolean

Indicates whether the keypad is paired for a Nuki device.

omnitec_metadata

Object

Metadata for an Omnitec device.

Show properties

has_gateway

Boolean

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

lock_alias

String

Operator-assigned alias for an Omnitec device.

lock_id

number

Lock ID for an Omnitec device.

lock_mac

String

Bluetooth MAC address for an Omnitec device.

lock_name

String

Lock name for an Omnitec device.

time_zone

String

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

timezone_raw_offset_ms

number

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

ring_metadata

Object

Metadata for a Ring device.

Show properties

device_id

String

Device ID for a Ring device.

device_name

String

Device name for a Ring device.

salto_ks_metadata

Object

Metadata for a Salto KS device.

Show properties

battery_level

String

Battery level for a Salto KS device.

customer_reference

String

Customer reference for a Salto KS device.

has_custom_pin_subscription

Boolean

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

lock_id

String

Lock ID for a Salto KS device.

lock_type

String

Lock type for a Salto KS device.

locked_state

String

Locked state for a Salto KS device.

model

String

Model for a Salto KS device.

site_id

String

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

site_name

String

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

salto_metadata

Object

deprecated

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

Show properties

battery_level

String

Battery level for a Salto device.

customer_reference

String

Customer reference for a Salto device.

lock_id

String

Lock ID for a Salto device.

lock_type

String

Lock type for a Salto device.

locked_state

String

Locked state for a Salto device.

model

String

Model for a Salto device.

site_id

String

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

site_name

String

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

schlage_metadata

Object

Metadata for a Schlage device.

Show properties

device_id

String

Device ID for a Schlage device.

device_name

String

Device name for a Schlage device.

model

String

Model for a Schlage device.

seam_bridge_metadata

Object

Metadata for Seam Bridge.

Show properties

device_num

number

Device number for Seam Bridge.

name

String

Name for Seam Bridge.

unlock_method

Enum (String)

Unlock method for Seam Bridge.

sensi_metadata

Object

Metadata for a Sensi device.

Show properties

device_id

String

Device ID for a Sensi device.

device_name

String

Device name for a Sensi device.

dual_setpoints_not_supported

Boolean

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

product_type

String

Product type for a Sensi device.

smartthings_metadata

Object

Metadata for a SmartThings device.

Show properties

device_id

String

Device ID for a SmartThings device.

device_name

String

Device name for a SmartThings device.

location_id

String

Location ID for a SmartThings device.

model

String

Model for a SmartThings device.

tado_metadata

Object

Metadata for a tado° device.

Show properties

device_type

String

Device type for a tado° device.

serial_no

String

Serial number for a tado° device.

tedee_metadata

Object

Metadata for a Tedee device.

Show properties

bridge_id

number

Bridge ID for a Tedee device.

bridge_name

String

Bridge name for a Tedee device.

device_id

number

Device ID for a Tedee device.

device_model

String

Device model for a Tedee device.

device_name

String

Device name for a Tedee device.

keypad_id

number

Keypad ID for a Tedee device.

serial_number

String

Serial number for a Tedee device.

ttlock_metadata

Object

Metadata for a TTLock device.

Show properties

feature_value

String

Feature value for a TTLock device.

features

Object

Features for a TTLock device.

Show properties

auto_lock_time_config

Boolean

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

incomplete_keyboard_passcode

Boolean

Indicates whether a TTLock device supports an incomplete keyboard passcode.

lock_command

Boolean

Indicates whether a TTLock device supports the lock command.

passcode

Boolean

Indicates whether a TTLock device supports a passcode.

passcode_management

Boolean

Indicates whether a TTLock device supports passcode management.

unlock_via_gateway

Boolean

Indicates whether a TTLock device supports unlock via gateway.

wifi

Boolean

Indicates whether a TTLock device supports Wi-Fi.

has_gateway

Boolean

Indicates whether a TTLock device has a gateway.

lock_alias

String

Lock alias for a TTLock device.

lock_id

number

Lock ID for a TTLock device.

timezone_raw_offset_ms

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.

wireless_keypads

Array

Wireless keypads for a TTLock device.

Show properties

wireless_keypad_id

number

ID for a wireless keypad for a TTLock device.

wireless_keypad_name

String

Name for a wireless keypad for a TTLock device.

two_n_metadata

Object

Metadata for a 2N device.

Show properties

device_id

number

Device ID for a 2N device.

device_name

String

Device name for a 2N device.

ultraloq_metadata

Object

Metadata for an Ultraloq device.

Show properties

device_id

String

Device ID for an Ultraloq device.

device_name

String

Device name for an Ultraloq device.

device_type

String

Device type for an Ultraloq device.

time_zone

String

IANA timezone for the Ultraloq device.

visionline_metadata

Object

Metadata for an ASSA ABLOY Visionline system.

Show properties

encoder_id

String

Encoder ID for an ASSA ABLOY Visionline system.

wyze_metadata

Object

Metadata for a Wyze device.

Show properties

device_id

String

Device ID for a Wyze device.

device_info_model

String

Device information model for a Wyze device.

device_name

String

Device name for a Wyze device.

keypad_uuid

String

Keypad UUID for a Wyze device.

locker_status_hardlock

number

Locker status (hardlock) for a Wyze device.

product_model

String

Product model for a Wyze device.

product_name

String

Product name for a Wyze device.

product_type

String

Product type for a Wyze device.

auto_lock_delay_seconds

number

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

auto_lock_enabled

Boolean

Indicates whether automatic locking is enabled.

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

code_constraints

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

constraint_type

Enum (String)

The constraint type.

max_length

number

Maximum name length constraint for access codes.

min_length

number

Minimum name length constraint for access codes.

door_open

Boolean

Indicates whether the door is open.

has_native_entry_events

Boolean

Indicates whether the device supports native entry events.

keypad_battery

Object

Keypad battery status.

Show properties

level

number

Keypad battery charge level.

locked

Boolean

Indicates whether the lock is locked.

max_active_codes_supported

number

Maximum number of active access codes that the device supports.

offline_time_frame_options

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

display_name

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

end_date_recurrence_rule

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.

matching_start_end_time

Boolean

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

max_duration

String

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

min_duration

String

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

start_date_recurrence_rule

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.

time_pairs

Array

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

Show properties

display_name

String

Label for the start/end time pairing.

end_time

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.

start_time

String

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

time_zone

String

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

online_time_frame_options

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

display_name

String

end_date_recurrence_rule

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.

matching_start_end_time

Boolean

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

max_duration

String

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

min_duration

String

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

start_date_recurrence_rule

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.

time_pairs

Array

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

Show properties

display_name

String

Label for the start/end time pairing.

end_time

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.

start_time

String

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

time_zone

String

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

supported_code_lengths

Array

Supported code lengths for access codes.

supports_backup_access_code_pool

Boolean

Indicates whether the device supports a backup access code pool.

active_thermostat_schedule

Object

deprecated

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

Show properties

climate_preset_key

String

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

created_at

String (ISO 8601)

Date and time at which the thermostat schedule was created.

device_id

String (UUID)

ID of the desired thermostat device.

ends_at

String (ISO 8601)

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

errors

Array

Errors associated with the thermostat schedule.

Show properties

error_code

String

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

message

String

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

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

String (ISO 8601)

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

thermostat_schedule_id

String (UUID)

ID of the thermostat schedule.

workspace_id

String (UUID)

ID of the workspace that contains the thermostat schedule.

active_thermostat_schedule_id

String (UUID)

ID of the active thermostat schedule.

available_climate_preset_modes

Array

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

available_climate_presets

Array

Available climate presets for the thermostat.

Show properties

can_delete

Boolean

Indicates whether the climate preset key can be deleted.

can_edit

Boolean

Indicates whether the climate preset key can be edited.

can_use_with_thermostat_daily_programs

Boolean

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

climate_preset_key

String

Unique key to identify the climate preset.

climate_preset_mode

Enum (String)

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

cooling_set_point_celsius

number

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

cooling_set_point_fahrenheit

number

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

display_name

String

Display name for the climate preset.

ecobee_metadata

Object

Metadata specific to the Ecobee climate, if applicable.

Show properties

climate_ref

String

Reference to the Ecobee climate, if applicable.

is_optimized

Boolean

Indicates if the climate preset is optimized by Ecobee.

owner

Enum (String)

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

fan_mode_setting

Enum (String)

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

heating_set_point_celsius

number

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

heating_set_point_fahrenheit

number

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

hvac_mode_setting

Enum (String)

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

manual_override_allowed

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.

name

String

User-friendly name to identify the climate preset.

available_fan_mode_settings

Array

Fan mode settings that the thermostat supports.

available_hvac_mode_settings

Array

HVAC mode settings that the thermostat supports.

current_climate_setting

Object

Current climate setting.

Show properties

can_delete

Boolean

Indicates whether the climate preset key can be deleted.

can_edit

Boolean

Indicates whether the climate preset key can be edited.

can_use_with_thermostat_daily_programs

Boolean

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

climate_preset_key

String

Unique key to identify the climate preset.

climate_preset_mode

Enum (String)

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

cooling_set_point_celsius

number

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

cooling_set_point_fahrenheit

number

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

display_name

String

Display name for the climate preset.

ecobee_metadata

Object

Metadata specific to the Ecobee climate, if applicable.

Show properties

climate_ref

String

Reference to the Ecobee climate, if applicable.

is_optimized

Boolean

Indicates if the climate preset is optimized by Ecobee.

owner

Enum (String)

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

fan_mode_setting

Enum (String)

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

heating_set_point_celsius

number

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

heating_set_point_fahrenheit

number

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

hvac_mode_setting

Enum (String)

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

manual_override_allowed

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.

name

String

User-friendly name to identify the climate preset.

default_climate_setting

Object

deprecated

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

Show properties

can_delete

Boolean

Indicates whether the climate preset key can be deleted.

can_edit

Boolean

Indicates whether the climate preset key can be edited.

can_use_with_thermostat_daily_programs

Boolean

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

climate_preset_key

String

Unique key to identify the climate preset.

climate_preset_mode

Enum (String)

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

cooling_set_point_celsius

number

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

cooling_set_point_fahrenheit

number

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

display_name

String

Display name for the climate preset.

ecobee_metadata

Object

Metadata specific to the Ecobee climate, if applicable.

Show properties

climate_ref

String

Reference to the Ecobee climate, if applicable.

is_optimized

Boolean

Indicates if the climate preset is optimized by Ecobee.

owner

Enum (String)

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

fan_mode_setting

Enum (String)

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

heating_set_point_celsius

number

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

heating_set_point_fahrenheit

number

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

hvac_mode_setting

Enum (String)

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

manual_override_allowed

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.

name

String

User-friendly name to identify the climate preset.

fallback_climate_preset_key

String

Key of the fallback climate preset for the thermostat.

fan_mode_setting

Enum (String)

deprecated

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

is_cooling

Boolean

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

is_fan_running

Boolean

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

is_heating

Boolean

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

is_temporary_manual_override_active

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.

max_cooling_set_point_celsius

number

Maximum cooling set point in °C.

max_cooling_set_point_fahrenheit

number

Maximum cooling set point in °F.

max_heating_set_point_celsius

number

Maximum heating set point in °C.

max_heating_set_point_fahrenheit

number

Maximum heating set point in °F.

max_thermostat_daily_program_periods_per_day

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.

max_unique_climate_presets_per_thermostat_weekly_program

number

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

min_cooling_set_point_celsius

number

Minimum cooling set point in °C.

min_cooling_set_point_fahrenheit

number

Minimum cooling set point in °F.

min_heating_cooling_delta_celsius

number

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

min_heating_cooling_delta_fahrenheit

number

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

min_heating_set_point_celsius

number

Minimum heating set point in °C.

min_heating_set_point_fahrenheit

number

Minimum heating set point in °F.

relative_humidity

number

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

temperature_celsius

number

Reported temperature in °C.

temperature_fahrenheit

number

Reported temperature in °F.

temperature_threshold

Object

Current temperature threshold set for the thermostat.

Show properties

lower_limit_celsius

number

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

lower_limit_fahrenheit

number

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

upper_limit_celsius

number

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

upper_limit_fahrenheit

number

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

thermostat_daily_program_period_precision_minutes

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.

thermostat_daily_programs

Array

Configured daily programs for the thermostat.

Show properties

created_at

String (ISO 8601)

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

device_id

String (UUID)

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

name

String

User-friendly name to identify the thermostat daily program.

periods

Array

Array of thermostat daily program periods.

Show properties

climate_preset_key

String

Key of the climate preset to activate at the starts_at_time.

starts_at_time

String

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

thermostat_daily_program_id

String (UUID)

ID of the thermostat daily program.

workspace_id

String (UUID)

ID of the workspace that contains the thermostat daily program.

thermostat_weekly_program

Object

Current weekly program for the thermostat.

Show properties

created_at

String (ISO 8601)

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

friday_program_id

String (UUID)

ID of the thermostat daily program to run on Fridays.

monday_program_id

String (UUID)

ID of the thermostat daily program to run on Mondays.

saturday_program_id

String (UUID)

ID of the thermostat daily program to run on Saturdays.

sunday_program_id

String (UUID)

ID of the thermostat daily program to run on Sundays.

thursday_program_id

String (UUID)

ID of the thermostat daily program to run on Thursdays.

tuesday_program_id

String (UUID)

ID of the thermostat daily program to run on Tuesdays.

wednesday_program_id

String (UUID)

ID of the thermostat daily program to run on Wednesdays.

space_ids

Array

IDs of the spaces the device is in.

warnings

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.

workspace_id

String (UUID)

Unique identifier for the Seam workspace associated with the device.

Thermostats

active_thermostat_schedule

Object

deprecated

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

Show properties

climate_preset_key

String

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

created_at

String (ISO 8601)

Date and time at which the thermostat schedule was created.

device_id

String (UUID)

ID of the desired thermostat device.

ends_at

String (ISO 8601)

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

errors

Array

Errors associated with the thermostat schedule.

Show properties

error_code

String

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

message

String

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

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

String (ISO 8601)

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

thermostat_schedule_id

String (UUID)

ID of the thermostat schedule.

workspace_id

String (UUID)

ID of the workspace that contains the thermostat schedule.

active_thermostat_schedule_id

String (UUID)

ID of the active thermostat schedule.

available_climate_preset_modes

Array

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

available_climate_presets

Array

Available climate presets for the thermostat.

Show properties

can_delete

Boolean

Indicates whether the climate preset key can be deleted.

can_edit

Boolean

Indicates whether the climate preset key can be edited.

can_use_with_thermostat_daily_programs

Boolean

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

climate_preset_key

String

Unique key to identify the climate preset.

climate_preset_mode

Enum (String)

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

cooling_set_point_celsius

number

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

cooling_set_point_fahrenheit

number

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

display_name

String

Display name for the climate preset.

ecobee_metadata

Object

Metadata specific to the Ecobee climate, if applicable.

Show properties

climate_ref

String

Reference to the Ecobee climate, if applicable.

is_optimized

Boolean

Indicates if the climate preset is optimized by Ecobee.

owner

Enum (String)

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

fan_mode_setting

Enum (String)

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

heating_set_point_celsius

number

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

heating_set_point_fahrenheit

number

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

hvac_mode_setting

Enum (String)

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

manual_override_allowed

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.

name

String

User-friendly name to identify the climate preset.

available_fan_mode_settings

Array

Fan mode settings that the thermostat supports.

available_hvac_mode_settings

Array

HVAC mode settings that the thermostat supports.

current_climate_setting

Object

Current climate setting.

Show properties

can_delete

Boolean

Indicates whether the climate preset key can be deleted.

can_edit

Boolean

Indicates whether the climate preset key can be edited.

can_use_with_thermostat_daily_programs

Boolean

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

climate_preset_key

String

Unique key to identify the climate preset.

climate_preset_mode

Enum (String)

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

cooling_set_point_celsius

number

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

cooling_set_point_fahrenheit

number

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

display_name

String

Display name for the climate preset.

ecobee_metadata

Object

Metadata specific to the Ecobee climate, if applicable.

Show properties

climate_ref

String

Reference to the Ecobee climate, if applicable.

is_optimized

Boolean

Indicates if the climate preset is optimized by Ecobee.

owner

Enum (String)

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

fan_mode_setting

Enum (String)

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

heating_set_point_celsius

number

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

heating_set_point_fahrenheit

number

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

hvac_mode_setting

Enum (String)

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

manual_override_allowed

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.

name

String

User-friendly name to identify the climate preset.

default_climate_setting

Object

deprecated

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

Show properties

can_delete

Boolean

Indicates whether the climate preset key can be deleted.

can_edit

Boolean

Indicates whether the climate preset key can be edited.

can_use_with_thermostat_daily_programs

Boolean

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

climate_preset_key

String

Unique key to identify the climate preset.

climate_preset_mode

Enum (String)

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

cooling_set_point_celsius

number

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

cooling_set_point_fahrenheit

number

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

display_name

String

Display name for the climate preset.

ecobee_metadata

Object

Metadata specific to the Ecobee climate, if applicable.

Show properties

climate_ref

String

Reference to the Ecobee climate, if applicable.

is_optimized

Boolean

Indicates if the climate preset is optimized by Ecobee.

owner

Enum (String)

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

fan_mode_setting

Enum (String)

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

heating_set_point_celsius

number

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

heating_set_point_fahrenheit

number

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

hvac_mode_setting

Enum (String)

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

manual_override_allowed

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.

name

String

User-friendly name to identify the climate preset.

fallback_climate_preset_key

String

Key of the fallback climate preset for the thermostat.

fan_mode_setting

Enum (String)

deprecated

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

is_cooling

Boolean

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

is_fan_running

Boolean

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

is_heating

Boolean

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

is_temporary_manual_override_active

Boolean

max_cooling_set_point_celsius

number

Maximum cooling set point in °C.

max_cooling_set_point_fahrenheit

number

Maximum cooling set point in °F.

max_heating_set_point_celsius

number

Maximum heating set point in °C.

max_heating_set_point_fahrenheit

number

Maximum heating set point in °F.

max_thermostat_daily_program_periods_per_day

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.

max_unique_climate_presets_per_thermostat_weekly_program

number

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

min_cooling_set_point_celsius

number

Minimum cooling set point in °C.

min_cooling_set_point_fahrenheit

number

Minimum cooling set point in °F.

min_heating_cooling_delta_celsius

number

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

min_heating_cooling_delta_fahrenheit

number

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

min_heating_set_point_celsius

number

Minimum heating set point in °C.

min_heating_set_point_fahrenheit

number

Minimum heating set point in °F.

relative_humidity

number

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

temperature_celsius

number

Reported temperature in °C.

temperature_fahrenheit

number

Reported temperature in °F.

temperature_threshold

Object

Current temperature threshold set for the thermostat.

Show properties

lower_limit_celsius

number

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

lower_limit_fahrenheit

number

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

upper_limit_celsius

number

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

upper_limit_fahrenheit

number

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

thermostat_daily_program_period_precision_minutes

number

thermostat_daily_programs

Array

Configured daily programs for the thermostat.

Show properties

created_at

String (ISO 8601)

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

device_id

String (UUID)

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

name

String

User-friendly name to identify the thermostat daily program.

periods

Array

Array of thermostat daily program periods.

Show properties

climate_preset_key

String

Key of the climate preset to activate at the starts_at_time.

starts_at_time

String

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

thermostat_daily_program_id

String (UUID)

ID of the thermostat daily program.

workspace_id

String (UUID)

ID of the workspace that contains the thermostat daily program.

thermostat_weekly_program

Object

Current weekly program for the thermostat.

Show properties

created_at

String (ISO 8601)

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

friday_program_id

String (UUID)

ID of the thermostat daily program to run on Fridays.

monday_program_id

String (UUID)

ID of the thermostat daily program to run on Mondays.

saturday_program_id

String (UUID)

ID of the thermostat daily program to run on Saturdays.

sunday_program_id

String (UUID)

ID of the thermostat daily program to run on Sundays.

thursday_program_id

String (UUID)

ID of the thermostat daily program to run on Thursdays.

tuesday_program_id

String (UUID)

ID of the thermostat daily program to run on Tuesdays.

wednesday_program_id

String (UUID)

ID of the thermostat daily program to run on Wednesdays.

Configure auto lock Thermostat Events

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