Skip to content

Versioning

The major version is part of the URL: /v1. The OpenAPI contract has its own version number (now 1.0.0), shown in the API reference.

Version 1 is stable:

  • New fields, operations, scopes and enum values can be added at any time. Ignore what you do not recognize.
  • Breaking changes come only in a new major version (/v2). The old version keeps working for at least 6 months after the new one is available. Responses from the old version then carry Deprecation and Sunset headers that say when it stops.