API versioning policy

We aim to ensure you have a smooth experience as we add and enhance the functionality of our APIs. This article outlines what you can expect from our API versioning and lifecycles so that your applications can be built reliably and powerfully.

How we version

We use major versioning (v1, v2, v3, etc.) to record the changes we make to each API independently. We may add features to the existing major version if they are backwards compatible — see the definitions below. These changes may be documented in the changelogs.

Backwards compatible changes

The following changes do not require a new major version and may be introduced at any time:

Breaking changes

The following changes are not backwards compatible and will only be introduced in a new major version: