GET api/v1/locations/{locationId}/devices/{deviceId}/automation/thermostats?AdditionalInput={AdditionalInput}

Get all automation thermostats.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
deviceId

Device ID

integer

Required

AdditionalInput

{"PanelInformation" :"Cache"} , {"PanelInformation" :"Live"}

string

Required

locationId

string

None.

Body Parameters

None.

Response Information

Resource Description

Collection of ThermostatInfo
NameDescriptionTypeAdditional information
DeviceID

integer

None.

id

integer

None.

name

string

None.

ThermostatIndex

integer

None.

CurrentOpMode

integer

None.

ThermostatMode

integer

None.

ThermostatFanMode

integer

None.

ThermostatVersion

string

None.

TemperatureScale

string

None.

heatSetPoint

integer

None.

coolSetPoint

integer

None.

energySaveHeatSetPoint

integer

None.

energySaveCoolSetPoint

integer

None.

temperatureScale

string

None.

currentTemperature

integer

None.

battery

integer

None.

fanModes

Collection of FanModeInfo

None.

thermostatModes

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "DeviceID": 1,
    "id": 2,
    "name": "sample string 3",
    "ThermostatIndex": 4,
    "CurrentOpMode": 5,
    "ThermostatMode": 7,
    "ThermostatFanMode": 9,
    "ThermostatVersion": "sample string 11",
    "TemperatureScale": "sample string 12",
    "heatSetPoint": 13,
    "coolSetPoint": 14,
    "energySaveHeatSetPoint": 15,
    "energySaveCoolSetPoint": 16,
    "temperatureScale": "sample string 17",
    "currentTemperature": 18,
    "battery": 19,
    "fanModes": [
      {
        "modeId": 1
      },
      {
        "modeId": 1
      }
    ],
    "thermostatModes": [
      {
        "modeId": 1
      },
      {
        "modeId": 1
      }
    ],
    "thermostatSupportedOpModes": [
      {
        "modeId": 1
      },
      {
        "modeId": 1
      }
    ],
    "deviceStatusId": 64,
    "DateTimeUpdated": "2025-06-03T02:44:18.2314071-04:00",
    "LyricUserID": 22,
    "PartnerReferenceData": {
      "LyricLocationID": 1,
      "LyricDeviceID": "sample string 2",
      "TemperatureScale": "sample string 3"
    },
    "DeviceType": 23,
    "AutoChangeOverEnabled": true,
    "SmartAway": {
      "Active": true,
      "TimeOfDay": "00:00:00.1234567",
      "DurationInHours": 3.1,
      "DurationInDays": 64,
      "LastUsedFormat": "Unknown",
      "EndsIn": "2025-06-03T02:44:18.2324068-04:00",
      "EndCoolSetPoint": 1.0,
      "EndHeatSetPoint": 1.0
    },
    "TCCthermostatdata": {
      "IndoorHumidity": 1,
      "OutdoorHumidity": 2,
      "OutdoorTemperature": 3,
      "TempHoldTime": "sample string 4",
      "IsScheduleCapable": true,
      "MinHeatSetPoint": 6,
      "MaxHeatSetPoint": 7,
      "MinCoolSetPoint": 8,
      "MaxCoolSetPoint": 9,
      "DeadbandforF": "sample string 10",
      "DeadbandforC": "sample string 11",
      "TCCScheduleHeatSetPoint": 12,
      "TCCScheduleCoolSetPoint": 13,
      "ThermostatMAC": "sample string 14",
      "PartnerLocationID": "sample string 15",
      "PartnerDeviceID": "sample string 16",
      "CurrentActivity": "sample string 17"
    },
    "Lyricthermostatdata": {
      "IndoorHumidity": 1,
      "OutdoorHumidity": 2,
      "OutdoorTemperature": 3,
      "TempHoldTime": "sample string 4",
      "MinHeatSetPoint": 5,
      "MaxHeatSetPoint": 6,
      "MinCoolSetPoint": 7,
      "MaxCoolSetPoint": 8,
      "DeadbandforF": "sample string 9",
      "DeadbandforC": "sample string 10",
      "ThermostatScheduleType": 11,
      "ThermostatScheduleStatus": 12
    },
    "ZoneName": "sample string 24"
  },
  {
    "DeviceID": 1,
    "id": 2,
    "name": "sample string 3",
    "ThermostatIndex": 4,
    "CurrentOpMode": 5,
    "ThermostatMode": 7,
    "ThermostatFanMode": 9,
    "ThermostatVersion": "sample string 11",
    "TemperatureScale": "sample string 12",
    "heatSetPoint": 13,
    "coolSetPoint": 14,
    "energySaveHeatSetPoint": 15,
    "energySaveCoolSetPoint": 16,
    "temperatureScale": "sample string 17",
    "currentTemperature": 18,
    "battery": 19,
    "fanModes": [
      {
        "modeId": 1
      },
      {
        "modeId": 1
      }
    ],
    "thermostatModes": [
      {
        "modeId": 1
      },
      {
        "modeId": 1
      }
    ],
    "thermostatSupportedOpModes": [
      {
        "modeId": 1
      },
      {
        "modeId": 1
      }
    ],
    "deviceStatusId": 64,
    "DateTimeUpdated": "2025-06-03T02:44:18.2314071-04:00",
    "LyricUserID": 22,
    "PartnerReferenceData": {
      "LyricLocationID": 1,
      "LyricDeviceID": "sample string 2",
      "TemperatureScale": "sample string 3"
    },
    "DeviceType": 23,
    "AutoChangeOverEnabled": true,
    "SmartAway": {
      "Active": true,
      "TimeOfDay": "00:00:00.1234567",
      "DurationInHours": 3.1,
      "DurationInDays": 64,
      "LastUsedFormat": "Unknown",
      "EndsIn": "2025-06-03T02:44:18.2324068-04:00",
      "EndCoolSetPoint": 1.0,
      "EndHeatSetPoint": 1.0
    },
    "TCCthermostatdata": {
      "IndoorHumidity": 1,
      "OutdoorHumidity": 2,
      "OutdoorTemperature": 3,
      "TempHoldTime": "sample string 4",
      "IsScheduleCapable": true,
      "MinHeatSetPoint": 6,
      "MaxHeatSetPoint": 7,
      "MinCoolSetPoint": 8,
      "MaxCoolSetPoint": 9,
      "DeadbandforF": "sample string 10",
      "DeadbandforC": "sample string 11",
      "TCCScheduleHeatSetPoint": 12,
      "TCCScheduleCoolSetPoint": 13,
      "ThermostatMAC": "sample string 14",
      "PartnerLocationID": "sample string 15",
      "PartnerDeviceID": "sample string 16",
      "CurrentActivity": "sample string 17"
    },
    "Lyricthermostatdata": {
      "IndoorHumidity": 1,
      "OutdoorHumidity": 2,
      "OutdoorTemperature": 3,
      "TempHoldTime": "sample string 4",
      "MinHeatSetPoint": 5,
      "MaxHeatSetPoint": 6,
      "MinCoolSetPoint": 7,
      "MaxCoolSetPoint": 8,
      "DeadbandforF": "sample string 9",
      "DeadbandforC": "sample string 10",
      "ThermostatScheduleType": 11,
      "ThermostatScheduleStatus": 12
    },
    "ZoneName": "sample string 24"
  }
]

application/xml, text/xml

Sample:
<ArrayOfThermostatInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.Models">
  <ThermostatInfo>
    <AutoChangeOverEnabled>true</AutoChangeOverEnabled>
    <CurrentOpMode>5</CurrentOpMode>
    <DateTimeUpdated>2025-06-03T02:44:18.2314071-04:00</DateTimeUpdated>
    <DeviceID>1</DeviceID>
    <DeviceType>23</DeviceType>
    <LyricUserID>22</LyricUserID>
    <Lyricthermostatdata>
      <DeadbandforC>sample string 10</DeadbandforC>
      <DeadbandforF>sample string 9</DeadbandforF>
      <IndoorHumidity>1</IndoorHumidity>
      <MaxCoolSetPoint>8</MaxCoolSetPoint>
      <MaxHeatSetPoint>6</MaxHeatSetPoint>
      <MinCoolSetPoint>7</MinCoolSetPoint>
      <MinHeatSetPoint>5</MinHeatSetPoint>
      <OutdoorHumidity>2</OutdoorHumidity>
      <OutdoorTemperature>3</OutdoorTemperature>
      <TempHoldTime>sample string 4</TempHoldTime>
      <ThermostatScheduleStatus>12</ThermostatScheduleStatus>
      <ThermostatScheduleType>11</ThermostatScheduleType>
    </Lyricthermostatdata>
    <PartnerReferenceData>
      <LyricDeviceID>sample string 2</LyricDeviceID>
      <LyricLocationID>1</LyricLocationID>
      <TemperatureScale>sample string 3</TemperatureScale>
    </PartnerReferenceData>
    <SmartAway>
      <Active>true</Active>
      <DurationInDays>64</DurationInDays>
      <DurationInHours>3.1</DurationInHours>
      <EndCoolSetPoint>1</EndCoolSetPoint>
      <EndHeatSetPoint>1</EndHeatSetPoint>
      <EndsIn xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2025-06-03T06:44:18.2324068Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>-240</d4p1:OffsetMinutes>
      </EndsIn>
      <LastUsedFormat>Unknown</LastUsedFormat>
      <TimeOfDay>PT0.1234567S</TimeOfDay>
    </SmartAway>
    <TCCthermostatdata>
      <CurrentActivity>sample string 17</CurrentActivity>
      <DeadbandforC>sample string 11</DeadbandforC>
      <DeadbandforF>sample string 10</DeadbandforF>
      <IndoorHumidity>1</IndoorHumidity>
      <IsScheduleCapable>true</IsScheduleCapable>
      <MaxCoolSetPoint>9</MaxCoolSetPoint>
      <MaxHeatSetPoint>7</MaxHeatSetPoint>
      <MinCoolSetPoint>8</MinCoolSetPoint>
      <MinHeatSetPoint>6</MinHeatSetPoint>
      <OutdoorHumidity>2</OutdoorHumidity>
      <OutdoorTemperature>3</OutdoorTemperature>
      <PartnerDeviceID>sample string 16</PartnerDeviceID>
      <PartnerLocationID>sample string 15</PartnerLocationID>
      <TCCScheduleCoolSetPoint>13</TCCScheduleCoolSetPoint>
      <TCCScheduleHeatSetPoint>12</TCCScheduleHeatSetPoint>
      <TempHoldTime>sample string 4</TempHoldTime>
      <ThermostatMAC>sample string 14</ThermostatMAC>
    </TCCthermostatdata>
    <TemperatureScale>sample string 12</TemperatureScale>
    <ThermostatFanMode>9</ThermostatFanMode>
    <ThermostatIndex>4</ThermostatIndex>
    <ThermostatMode>7</ThermostatMode>
    <ThermostatVersion>sample string 11</ThermostatVersion>
    <ZoneName>sample string 24</ZoneName>
    <battery>19</battery>
    <coolSetPoint>14</coolSetPoint>
    <currentOpMode>Unknown</currentOpMode>
    <currentTemperature>18</currentTemperature>
    <deviceStatusId>64</deviceStatusId>
    <energySaveCoolSetPoint>16</energySaveCoolSetPoint>
    <energySaveHeatSetPoint>15</energySaveHeatSetPoint>
    <fanModes>
      <FanModeInfo>
        <modeId>1</modeId>
      </FanModeInfo>
      <FanModeInfo>
        <modeId>1</modeId>
      </FanModeInfo>
    </fanModes>
    <heatSetPoint>13</heatSetPoint>
    <id>2</id>
    <name>sample string 3</name>
    <temperatureScale>sample string 17</temperatureScale>
    <thermostatFanMode>Unknown</thermostatFanMode>
    <thermostatMode>Unknown</thermostatMode>
    <thermostatModes>
      <ModeInfo>
        <modeId>1</modeId>
      </ModeInfo>
      <ModeInfo>
        <modeId>1</modeId>
      </ModeInfo>
    </thermostatModes>
    <thermostatSupportedOpModes>
      <SupportedModeInfo>
        <modeId>1</modeId>
      </SupportedModeInfo>
      <SupportedModeInfo>
        <modeId>1</modeId>
      </SupportedModeInfo>
    </thermostatSupportedOpModes>
  </ThermostatInfo>
  <ThermostatInfo>
    <AutoChangeOverEnabled>true</AutoChangeOverEnabled>
    <CurrentOpMode>5</CurrentOpMode>
    <DateTimeUpdated>2025-06-03T02:44:18.2314071-04:00</DateTimeUpdated>
    <DeviceID>1</DeviceID>
    <DeviceType>23</DeviceType>
    <LyricUserID>22</LyricUserID>
    <Lyricthermostatdata>
      <DeadbandforC>sample string 10</DeadbandforC>
      <DeadbandforF>sample string 9</DeadbandforF>
      <IndoorHumidity>1</IndoorHumidity>
      <MaxCoolSetPoint>8</MaxCoolSetPoint>
      <MaxHeatSetPoint>6</MaxHeatSetPoint>
      <MinCoolSetPoint>7</MinCoolSetPoint>
      <MinHeatSetPoint>5</MinHeatSetPoint>
      <OutdoorHumidity>2</OutdoorHumidity>
      <OutdoorTemperature>3</OutdoorTemperature>
      <TempHoldTime>sample string 4</TempHoldTime>
      <ThermostatScheduleStatus>12</ThermostatScheduleStatus>
      <ThermostatScheduleType>11</ThermostatScheduleType>
    </Lyricthermostatdata>
    <PartnerReferenceData>
      <LyricDeviceID>sample string 2</LyricDeviceID>
      <LyricLocationID>1</LyricLocationID>
      <TemperatureScale>sample string 3</TemperatureScale>
    </PartnerReferenceData>
    <SmartAway>
      <Active>true</Active>
      <DurationInDays>64</DurationInDays>
      <DurationInHours>3.1</DurationInHours>
      <EndCoolSetPoint>1</EndCoolSetPoint>
      <EndHeatSetPoint>1</EndHeatSetPoint>
      <EndsIn xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2025-06-03T06:44:18.2324068Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>-240</d4p1:OffsetMinutes>
      </EndsIn>
      <LastUsedFormat>Unknown</LastUsedFormat>
      <TimeOfDay>PT0.1234567S</TimeOfDay>
    </SmartAway>
    <TCCthermostatdata>
      <CurrentActivity>sample string 17</CurrentActivity>
      <DeadbandforC>sample string 11</DeadbandforC>
      <DeadbandforF>sample string 10</DeadbandforF>
      <IndoorHumidity>1</IndoorHumidity>
      <IsScheduleCapable>true</IsScheduleCapable>
      <MaxCoolSetPoint>9</MaxCoolSetPoint>
      <MaxHeatSetPoint>7</MaxHeatSetPoint>
      <MinCoolSetPoint>8</MinCoolSetPoint>
      <MinHeatSetPoint>6</MinHeatSetPoint>
      <OutdoorHumidity>2</OutdoorHumidity>
      <OutdoorTemperature>3</OutdoorTemperature>
      <PartnerDeviceID>sample string 16</PartnerDeviceID>
      <PartnerLocationID>sample string 15</PartnerLocationID>
      <TCCScheduleCoolSetPoint>13</TCCScheduleCoolSetPoint>
      <TCCScheduleHeatSetPoint>12</TCCScheduleHeatSetPoint>
      <TempHoldTime>sample string 4</TempHoldTime>
      <ThermostatMAC>sample string 14</ThermostatMAC>
    </TCCthermostatdata>
    <TemperatureScale>sample string 12</TemperatureScale>
    <ThermostatFanMode>9</ThermostatFanMode>
    <ThermostatIndex>4</ThermostatIndex>
    <ThermostatMode>7</ThermostatMode>
    <ThermostatVersion>sample string 11</ThermostatVersion>
    <ZoneName>sample string 24</ZoneName>
    <battery>19</battery>
    <coolSetPoint>14</coolSetPoint>
    <currentOpMode>Unknown</currentOpMode>
    <currentTemperature>18</currentTemperature>
    <deviceStatusId>64</deviceStatusId>
    <energySaveCoolSetPoint>16</energySaveCoolSetPoint>
    <energySaveHeatSetPoint>15</energySaveHeatSetPoint>
    <fanModes>
      <FanModeInfo>
        <modeId>1</modeId>
      </FanModeInfo>
      <FanModeInfo>
        <modeId>1</modeId>
      </FanModeInfo>
    </fanModes>
    <heatSetPoint>13</heatSetPoint>
    <id>2</id>
    <name>sample string 3</name>
    <temperatureScale>sample string 17</temperatureScale>
    <thermostatFanMode>Unknown</thermostatFanMode>
    <thermostatMode>Unknown</thermostatMode>
    <thermostatModes>
      <ModeInfo>
        <modeId>1</modeId>
      </ModeInfo>
      <ModeInfo>
        <modeId>1</modeId>
      </ModeInfo>
    </thermostatModes>
    <thermostatSupportedOpModes>
      <SupportedModeInfo>
        <modeId>1</modeId>
      </SupportedModeInfo>
      <SupportedModeInfo>
        <modeId>1</modeId>
      </SupportedModeInfo>
    </thermostatSupportedOpModes>
  </ThermostatInfo>
</ArrayOfThermostatInfo>