List Thermostats

List all the thermostats

List all Thermostats

GET https://connect.getseam.com/thermostats/list

Query Parameters

Name
Type
Description

connected_account_id

String

ID of the Connected Account the thermostats belongs to

connected_account_ids

Array<String>

IDs of the Connected Accounts the thermostats belongs to

connect_webview_id

String

ID of the Connect Webview that was used to connect the thermostats

device_type

String

Filter the thermostats by their device account type

manufacturer

String

Filter the thermostats by their manufacturer

device_ids

String

The Device IDs of the thermostats

Headers

Name
Type
Description

Authorization*

String

Bearer <API_KEY>

{
  "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",
          "heatcool",
          "off"
        ],
        "current_climate_setting": {
          "automatic_heating_enabled": true,
          "automatic_cooling_enabled": true,
          "hvac_mode_setting": "heatcool",
          "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",
          "heatcool",
          "off"
        ],
        "current_climate_setting": {
          "automatic_heating_enabled": true,
          "automatic_cooling_enabled": true,
          "hvac_mode_setting": "heatcool",
          "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": []
    }
  ]
}

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",
#           "heatcool",
#           "off"
#         ],
#         "current_climate_setting": {
#           "automatic_heating_enabled": true,
#           "automatic_cooling_enabled": true,
#           "hvac_mode_setting": "heatcool",
#           "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",
#           "heatcool",
#           "off"
#         ],
#         "current_climate_setting": {
#           "automatic_heating_enabled": true,
#           "automatic_cooling_enabled": true,
#           "hvac_mode_setting": "heatcool",
#           "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": []
#     }
#   ]

Parameters

connected_account_id

type: string Optional

ID of the Connected Account the thermostats belong to

connected_account_ids

type: Array<string> Optional

IDs of the Connected Accounts the thermostats belong to

connect_webview_id

type: string Optional

ID of Connect Webview

device_type

type: string Optional

The account type of the thermostats we want to retrieve

manufacturer

type: String Optional

ID of Workspace

device_ids

type: Array<string> Optional

Device IDs of the thermostats we want to retrieve

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",
          "heatcool",
          "off"
        ],
        "current_climate_setting": {
          "automatic_heating_enabled": true,
          "automatic_cooling_enabled": true,
          "hvac_mode_setting": "heatcool",
          "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",
          "heatcool",
          "off"
        ],
        "current_climate_setting": {
          "automatic_heating_enabled": true,
          "automatic_cooling_enabled": true,
          "hvac_mode_setting": "heatcool",
          "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

Was this helpful?