Ecobee
App · 13 actions
Read thermostats and reports, manage temperature holds, vacations, alerts and groups.
Actions
| Action | What it does |
|---|---|
| Acknowledge thermostat alert | Acknowledge thermostat alert. |
| Create thermostat vacation | Create thermostat vacation. |
| Delete thermostat vacation | Delete thermostat vacation. |
| Get meter report | Get meter report. |
| Get runtime report | Get runtime report. |
| Get thermostat summary | Get thermostat summary. |
| List thermostat groups | List thermostat groups. |
| List thermostats | List thermostats. |
| Resume thermostat program | Resume thermostat program. |
| Send thermostat message | Send thermostat message. |
| Set HVAC mode | Set HVAC mode. |
| Set temperature hold | Set temperature hold. |
| Update thermostat group | Update thermostat group. |
Acknowledge thermostat alert
Acknowledge thermostat alert.
Inputs
- Thermostat
thermostat_idtextRequired - Thermostat ID.
- Acknowledge ref
acknowledge_reftextRequired - Acknowledge ref.
- Acknowledge type
acknowledge_typetextRequired - Acknowledge type.One of:
accept,decline,defer.
Outputs
dataobject- Ecobee response data.
Example output
{
"data": {}
}Create thermostat vacation
Create thermostat vacation.
Inputs
- Thermostat
thermostat_idtextRequired - Thermostat ID.
- Name
nametextRequired - Name.
- Heat temperature
heat_temperaturenumberRequired - Heat temperature.From 5 to 95.
- Cool temperature
cool_temperaturenumberRequired - Cool temperature.From 5 to 95.
- Temperature unit
temperature_unittextRequired - Temperature unit.One of:
C,F. - Start time
start_timedate and timeRequired - Start time.
- End time
end_timedate and timeRequired - End time.
- Fan
fantext - Fan.One of:
auto,on. - Time zone
time_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
- Thermostat
thermostat_idtextRequired - Thermostat ID.
- Name
nametextRequired - Name.
Outputs
dataobject- Ecobee response data.
Example output
{
"data": {}
}Get meter report
Get meter report.
Inputs
- Thermostat
thermostat_idtextRequired - Thermostat ID.
- Start date
start_datedateRequired - Start date.
- End date
end_datedateRequired - End date.
Outputs
dataobject- Ecobee response data.
Example output
{
"data": {
"meterList": [],
"status": {
"code": 1,
"message": "example"
}
}
}Get runtime report
Get runtime report.
Inputs
- Thermostat
thermostat_idtextRequired - Thermostat ID.
- Start date
start_datedateRequired - Start date.
- End date
end_datedateRequired - End date.
- Columns
columnslistRequired - 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
- Thermostat
thermostat_idtext - Thermostat ID.
- Page
pagenumber - Page.At least 1.
- Include runtime
include_runtimetrue/false - Include runtime.
- Include settings
include_settingstrue/false - Include settings.
- Include events
include_eventstrue/false - Include events.
- Include alerts
include_alertstrue/false - Include alerts.
- Include sensors
include_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
- Thermostat
thermostat_idtextRequired - Thermostat ID.
- Resume all
resume_alltrue/false - Resume all.
Outputs
dataobject- Ecobee response data.
Example output
{
"data": {}
}Send thermostat message
Send thermostat message.
Inputs
- Thermostat
thermostat_idtextRequired - Thermostat ID.
- Text
texttextRequired - Text.
Outputs
dataobject- Ecobee response data.
Example output
{
"data": {}
}Set HVAC mode
Set HVAC mode.
Inputs
- Thermostat
thermostat_idtextRequired - Thermostat ID.
- Hvac mode
hvac_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
- Thermostat
thermostat_idtextRequired - Thermostat ID.
- Heat temperature
heat_temperaturenumberRequired - Heat temperature.From 5 to 95.
- Cool temperature
cool_temperaturenumberRequired - Cool temperature.From 5 to 95.
- Temperature unit
temperature_unittextRequired - Temperature unit.One of:
C,F. - Hold type
hold_typetextRequired - Hold type.One of:
nextTransition,indefinite,holdHours. - Hold hours
hold_hoursnumber - Hold hours.From 1 to 24.
- Fan
fantext - Fan.One of:
auto,on.
Outputs
dataobject- Ecobee response data.
Example output
{
"data": {}
}Update thermostat group
Update thermostat group.
Inputs
- Group ref
group_reftextRequired - Group ref.
- Group name
group_nametextRequired - Group name.
Outputs
dataobject- Ecobee response data.
Example output
{
"data": {}
}