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

OAuth 2.0 PIN and authorization-code flows and token refresh.

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

Tagged areas include Authorization. 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 2 paths, and defines 4 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 2 paths 4 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 Authorization 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 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Authorization 2

OAuth 2.0 PIN and authorization-code flows and token refresh.

GET
/authorize
Begin authorization (PIN or authorization code)
authorize 5 params → 200
POST
/token
Exchange or refresh tokens
token 6 params → 200400

Schemas 4

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

PinResponse
object
5 properties
TokenResponse
object
5 properties
StatusResponse
object
1 property
Status
object
Standard ecobee response status.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ecobee-authorization-api-openapi.yml Raw ↑

Other APIs ecobee publishes across the network.

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