Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ecobee Hierarchy API

EMS/Utility management-set hierarchy of thermostats, sets, and users.

ecobee Hierarchy API is one of 7 APIs that ecobee publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Hierarchy. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 5 operations across 3 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 2 base URLs: https://api.ecobee.com/1, https://api.ecobee.com.

5 operations 3 paths 5 schemas 2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.ecobee.com/1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

ecobee Hierarchy API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 access token passed as Authorization: Bearer ACCESSTOKEN on all data-plane requests to https://api.ecobee.com/1.

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Hierarchy 5

EMS/Utility management-set hierarchy of thermostats, sets, and users.

POST
/hierarchy/thermostat
Register, unregister, move, or assign thermostats
hierarchyThermostat 1 param body → 200401
GET
/hierarchy/set
List management sets
listHierarchySets 1 param → 200401
POST
/hierarchy/set
Add, remove, rename, or move a management set
manageHierarchySet 1 param body → 200401
GET
/hierarchy/user
List hierarchy users
listHierarchyUsers 1 param → 200401
POST
/hierarchy/user
Add, update, remove, or unregister a hierarchy user
manageHierarchyUser 1 param body → 200401

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are HierarchyUserRequest (4 properties), HierarchySetRequest (4 properties), HierarchyThermostatRequest (3 properties), Status (2 properties). Each schema is shown below with its type and property counts.

HierarchyThermostatRequest
object
3 properties 1 required
HierarchySetRequest
object
4 properties 1 required
StatusResponse
object
1 property
HierarchyUserRequest
object
4 properties 1 required
Status
object
Standard ecobee response status.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ecobee-hierarchy-api-openapi.yml Raw ↑

Other APIs ecobee publishes across the network.

ecobee Authorization API
ecobee Demand Response API
ecobee Group API
ecobee Reports API
ecobee Thermostat API
ecobee Thermostat Update API