Get Thermostat

Get a Thermostat on your account by its Device ID

Get a Thermostat

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

Query Parameters

Name	Type	Description
device_id	String	ID of Device
name	String	Name of the Device

Headers

Name	Type	Description
Authorization*	String	Bearer <API_KEY>

200: OK

{
  "thermostat": {
    "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": []
  }
}

404: Not Found

{
  "error": {
    "type": "device_not_found",
    "message": "Device not found",
    "data": {
      "device_id": "a83690b2-2b70-409a-9a94-426699b84c97"
    },
    "request_id": "8e730f9a-5b56-41aa-ad78-86a1a7b82e0a"
  },
  "ok": false
}

400: Bad Request

{
  "error": {
    "type": "invalid_input",
    "message": "Either 'device_id' or 'name' is required",
    "validation_errors": {
      "_errors": [
        "Either 'device_id' or 'name' is required"
      ]
    },
    "request_id": "802ee381-b068-4b9d-a722-bae968de9174"
  },
  "ok": false
}

Code Example

Python

from seamapi import Seam

seam = Seam()
device_id = "123e4567-e89b-12d3-a456-426614174000"
thermostat = seam.thermostats.get(device_id)

print(thermostat)

# Thermostat(
#     device_id="123e4567-e89b-12d3-a456-426614174000",
#     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=None,
#     connected_account_id="123e4567-e89b-12d3-a456-426614174001",
#     workspace_id="123e4567-e89b-12d3-a456-426614174002",
#     created_at="2023-06-01T11:14:37.116Z",
#     errors=[]
# )

Javascript

import Seam from "seamapi"

const seam = Seam()
const deviceId = "123e4567-e89b-12d3-a456-426614174000"
const device = await seam.thermostats.get({device_id: deviceId})

console.log(device)

/*
{
  "thermostat": {
    "device_id": "123e4567-e89b-12d3-a456-426614174000",
    "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": "123e4567-e89b-12d3-a456-426614174001",
    "workspace_id": "123e4567-e89b-12d3-a456-426614174002",
    "created_at": "2023-06-01T11:14:37.116Z",
    "errors": []
  }
}
*/

Parameters

device_id	type: string	ID of the Device
name	type: string	Name of the Device

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

JSON

{
  "thermostat": {
    "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": []
  },
  "ok": true
}