API Versioning

Overview

We periodically release new, dated versions of the API whenever we make breaking changes. While we try to only make backward-compatible changes, we sometimes have to make breaking ones to iterate on the API.

Methodology

We consider the following changes backward compatible:

1. New API endpoints
2. New optional parameters to existing API endpoints
3. New data elements, fields, or enum values to existing response objects
4. New error types

All updates to our API, both breaking and non-breaking, will be documented in our upcoming, publicly-accessible changelog.

Sending API requests

All API requests must specify the desired version using the Closure-API-Version header. The current API version is 2022-04-01.

Valid versions

1. 2022-04-01 (current version)