List Thermostats

Returns a list of thermostats connected to your workspace. If no thermostats are connected, the list will be empty.

Code Example

seam.thermostats.list()

# [
#     {
#       "device_id": "a83690b2-2b70-409a-9a94-426699b84c97",
#       "device_type": "ecobee_thermostat",
#       "capabilities_supported": ["thermostat"],
#       "properties": {
#         "name": "Entryway",
#         "online": true,
#         "relative_humidity": 0.36,
#         "temperature_fahrenheit": 70,
#         "can_enable_automatic_cooling": true,
#         "can_enable_automatic_heating": true,
#         "available_hvac_mode_settings": [
#           "cool",
#           "heat",
#           "heat_cool",
#           "off"
#         ],
#         "current_climate_setting": {
#           "automatic_heating_enabled": true,
#           "automatic_cooling_enabled": true,
#           "hvac_mode_setting": "heat_cool",
#           "cooling_set_point_fahrenheit": 75,
#           "heating_set_point_fahrenheit": 65,
#           "manual_override_allowed": false 
#         }
#       },
#       "location": null,
#       "connected_account_id": "b0be0837-29c2-4cb1-8560-42dfd07fb877",
#       "workspace_id": "f97073eb-c003-467a-965b-e6dba3a0131d",
#       "created_at": "2023-06-01T11:14:37.116Z",
#       "errors": []
#     },
#     {
#       "device_id": "a3f30bd2-f6d7-4bad-ba89-1bad3bf1bce4",
#       "device_type": "ecobee_thermostat",
#       "capabilities_supported": ["thermostat"],
#       "properties": {
#         "name": "Entryway",
#         "online": true,
#         "relative_humidity": 0.36,
#         "temperature_fahrenheit": 70,
#         "can_enable_automatic_cooling": true,
#         "can_enable_automatic_heating": true,
#         "available_hvac_mode_settings": [
#           "cool",
#           "heat",
#           "heat_cool",
#           "off"
#         ],
#         "current_climate_setting": {
#           "automatic_heating_enabled": true,
#           "automatic_cooling_enabled": true,
#           "hvac_mode_setting": "heat_cool",
#           "cooling_set_point_fahrenheit": 75,
#           "heating_set_point_fahrenheit": 65,
#           "manual_override_allowed": false 
#         }
#       },
#       "location": null,
#       "connected_account_id": "b0be0837-29c2-4cb1-8560-42dfd07fb877",
#       "workspace_id": "f97073eb-c003-467a-965b-e6dba3a0131d",
#       "created_at": "2023-06-01T11:14:37.116Z",
#       "errors": []
#     }
#   ]

Request Body Parameters

ParameterTypeDescription

connected_account_id

String Optional

ID of the connected account to which the thermostats belong

connected_account_ids

Array<string> Optional

IDs of the connected accounts to which the thermostats belong

connect_webview_id

String Optional

ID of the Connect Webview that connected the thermostats to Seam

device_type

String Optional

Account type of the thermostats

manufacturer

String Optional

ID of the workspace

device_ids

Array<string> Optional

Device IDs of the thermostats

user_identifier_key

String Optional

Your own internal user ID for the user by which to filter thermostats

Response

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here.

JSON format

{
  "thermostats": [
    {
      "device_id": "a83690b2-2b70-409a-9a94-426699b84c97",
      "device_type": "ecobee_thermostat",
      "capabilities_supported": ["thermostat"],
      "properties": {
        "name": "Entryway",
        "online": true,
        "relative_humidity": 0.36,
        "temperature_fahrenheit": 70,
        "can_enable_automatic_cooling": true,
        "can_enable_automatic_heating": true,
        "available_hvac_mode_settings": [
          "cool",
          "heat",
          "heat_cool",
          "off"
        ],
        "current_climate_setting": {
          "automatic_heating_enabled": true,
          "automatic_cooling_enabled": true,
          "hvac_mode_setting": "heat_cool",
          "cooling_set_point_fahrenheit": 75,
          "heating_set_point_fahrenheit": 65,
          "manual_override_allowed": false 
        }
      },
      "location": null,
      "connected_account_id": "b0be0837-29c2-4cb1-8560-42dfd07fb877",
      "workspace_id": "f97073eb-c003-467a-965b-e6dba3a0131d",
      "created_at": "2023-06-01T11:14:37.116Z",
      "errors": []
    },
    {
      "device_id": "a3f30bd2-f6d7-4bad-ba89-1bad3bf1bce4",
      "device_type": "ecobee_thermostat",
      "capabilities_supported": ["thermostat"],
      "properties": {
        "name": "Entryway",
        "online": true,
        "relative_humidity": 0.36,
        "temperature_fahrenheit": 70,
        "can_enable_automatic_cooling": true,
        "can_enable_automatic_heating": true,
        "available_hvac_mode_settings": [
          "cool",
          "heat",
          "heat_cool",
          "off"
        ],
        "current_climate_setting": {
          "automatic_heating_enabled": true,
          "automatic_cooling_enabled": true,
          "hvac_mode_setting": "heat_cool",
          "cooling_set_point_fahrenheit": 75,
          "heating_set_point_fahrenheit": 65,
          "manual_override_allowed": false 
        }
      },
      "location": null,
      "connected_account_id": "b0be0837-29c2-4cb1-8560-42dfd07fb877",
      "workspace_id": "f97073eb-c003-467a-965b-e6dba3a0131d",
      "created_at": "2023-06-01T11:14:37.116Z",
      "errors": []
    }
  ],
  "ok": true
}

Last updated

Logo

Β© Seam Labs, Inc. All rights reserved.