Ecobee

App · 13 actions

Read thermostats and reports, manage temperature holds, vacations, alerts and groups.

Actions

ActionWhat it does
Acknowledge thermostat alertAcknowledge thermostat alert.
Create thermostat vacationCreate thermostat vacation.
Delete thermostat vacationDelete thermostat vacation.
Get meter reportGet meter report.
Get runtime reportGet runtime report.
Get thermostat summaryGet thermostat summary.
List thermostat groupsList thermostat groups.
List thermostatsList thermostats.
Resume thermostat programResume thermostat program.
Send thermostat messageSend thermostat message.
Set HVAC modeSet HVAC mode.
Set temperature holdSet temperature hold.
Update thermostat groupUpdate thermostat group.

Acknowledge thermostat alert

Acknowledge thermostat alert.

Inputs

Thermostatthermostat_idtextRequired
Thermostat ID.
Acknowledge refacknowledge_reftextRequired
Acknowledge ref.
Acknowledge typeacknowledge_typetextRequired
Acknowledge type.One of: accept, decline, defer.

Outputs

dataobject
Ecobee response data.
Example output
{
  "data": {}
}

Create thermostat vacation

Create thermostat vacation.

Inputs

Thermostatthermostat_idtextRequired
Thermostat ID.
NamenametextRequired
Name.
Heat temperatureheat_temperaturenumberRequired
Heat temperature.From 5 to 95.
Cool temperaturecool_temperaturenumberRequired
Cool temperature.From 5 to 95.
Temperature unittemperature_unittextRequired
Temperature unit.One of: C, F.
Start timestart_timedate and timeRequired
Start time.
End timeend_timedate and timeRequired
End time.
Fanfantext
Fan.One of: auto, on.
Time zonetime_zonetextRequired
The thermostat’s IANA time zone. Dates are converted to this zone, including daylight-saving changes.One of: Africa/Abidjan, Africa/Accra, Africa/Addis_Ababa (Africa/addis ababa), Africa/Algiers, Africa/Asmara, Africa/Asmera, Africa/Bamako, Africa/Bangui, Africa/Banjul, Africa/Bissau, and 589 more.

Outputs

dataobject
Ecobee response data.
Example output
{
  "data": {}
}

Delete thermostat vacation

Delete thermostat vacation.

Inputs

Thermostatthermostat_idtextRequired
Thermostat ID.
NamenametextRequired
Name.

Outputs

dataobject
Ecobee response data.
Example output
{
  "data": {}
}

Get meter report

Get meter report.

Inputs

Thermostatthermostat_idtextRequired
Thermostat ID.
Start datestart_datedateRequired
Start date.
End dateend_datedateRequired
End date.

Outputs

dataobject
Ecobee response data.
Example output
{
  "data": {
    "meterList": [],
    "status": {
      "code": 1,
      "message": "example"
    }
  }
}

Get runtime report

Get runtime report.

Inputs

Thermostatthermostat_idtextRequired
Thermostat ID.
Start datestart_datedateRequired
Start date.
End dateend_datedateRequired
End date.
ColumnscolumnslistRequired
Columns.One or more of: auxHeat1, auxHeat2, auxHeat3, compCool1, compCool2, compHeat1, compHeat2, fan, humidifier, dehumidifier, and 8 more.

Outputs

dataobject
Ecobee response data.
Example output
{
  "data": {
    "reportList": [],
    "status": {
      "code": 1,
      "message": "example"
    }
  }
}

Get thermostat summary

Get thermostat summary.

Inputs

None.

Outputs

dataobject
Ecobee response data.
Example output
{
  "data": {
    "revisionList": [],
    "status": {
      "code": 1,
      "message": "example"
    },
    "statusList": []
  }
}

List thermostat groups

List thermostat groups.

Inputs

None.

Outputs

dataobject
Ecobee response data.
Example output
{
  "data": {
    "groups": [],
    "status": {
      "code": 1,
      "message": "example"
    }
  }
}

List thermostats

List thermostats.

Inputs

Thermostatthermostat_idtext
Thermostat ID.
Pagepagenumber
Page.At least 1.
Include runtimeinclude_runtimetrue/false
Include runtime.
Include settingsinclude_settingstrue/false
Include settings.
Include eventsinclude_eventstrue/false
Include events.
Include alertsinclude_alertstrue/false
Include alerts.
Include sensorsinclude_sensorstrue/false
Include sensors.

Outputs

dataobject
Ecobee response data.
Example output
{
  "data": {
    "page": {
      "page": 1,
      "pageSize": 1,
      "total": 1,
      "totalPages": 1
    },
    "status": {
      "code": 1,
      "message": "example"
    },
    "thermostatList": []
  }
}

Resume thermostat program

Resume thermostat program.

Inputs

Thermostatthermostat_idtextRequired
Thermostat ID.
Resume allresume_alltrue/false
Resume all.

Outputs

dataobject
Ecobee response data.
Example output
{
  "data": {}
}

Send thermostat message

Send thermostat message.

Inputs

Thermostatthermostat_idtextRequired
Thermostat ID.
TexttexttextRequired
Text.

Outputs

dataobject
Ecobee response data.
Example output
{
  "data": {}
}

Set HVAC mode

Set HVAC mode.

Inputs

Thermostatthermostat_idtextRequired
Thermostat ID.
Hvac modehvac_modetextRequired
Hvac mode.One of: auto, auxHeatOnly, cool, heat, off.

Outputs

dataobject
Ecobee response data.
Example output
{
  "data": {}
}

Set temperature hold

Set temperature hold.

Inputs

Thermostatthermostat_idtextRequired
Thermostat ID.
Heat temperatureheat_temperaturenumberRequired
Heat temperature.From 5 to 95.
Cool temperaturecool_temperaturenumberRequired
Cool temperature.From 5 to 95.
Temperature unittemperature_unittextRequired
Temperature unit.One of: C, F.
Hold typehold_typetextRequired
Hold type.One of: nextTransition, indefinite, holdHours.
Hold hourshold_hoursnumber
Hold hours.From 1 to 24.
Fanfantext
Fan.One of: auto, on.

Outputs

dataobject
Ecobee response data.
Example output
{
  "data": {}
}

Update thermostat group

Update thermostat group.

Inputs

Group refgroup_reftextRequired
Group ref.
Group namegroup_nametextRequired
Group name.

Outputs

dataobject
Ecobee response data.
Example output
{
  "data": {}
}

On this page