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 Group API

Group registered thermostats.

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

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

This API exposes 2 operations across 1 path, and defines 6 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.

2 operations 1 paths 6 schemas 1 GET1 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 Group 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 2

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

Group 2

Group registered thermostats.

GET
/group
Get groups
getGroups 1 param → 200401
POST
/group
Update groups
updateGroups 1 param body → 200401

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Selection (9 properties), Group (5 properties), Status (2 properties), GroupRequest (2 properties). Each schema is shown below with its type and property counts.

Selection
object
Determines which thermostats and which sub-objects are returned or acted upon.
9 properties 1 required
GroupResponse
object
2 properties
StatusResponse
object
1 property
GroupRequest
object
2 properties 2 required
Group
object
5 properties
Status
object
Standard ecobee response status.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ecobee-group-api-openapi.yml Raw ↑

Other APIs ecobee publishes across the network.

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