How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
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.2.0, 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.2.0
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 HierarchySetRequest (4 properties), HierarchyUserRequest (4 properties), HierarchyThermostatRequest (3 properties), Status (2 properties). Each schema is shown below with its type and property counts.

HierarchyUserRequest
object
4 properties 1 required
HierarchyThermostatRequest
object
3 properties 1 required
StatusResponse
object
1 property
HierarchySetRequest
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
Where this information came from

This is an independent, third-party profile of ecobee Hierarchy API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.