API versioning and changelogs

How we change our APIs without breaking your tools

Last reviewed

Our versioning policy

The same rules apply to every external API, including the tools our MCP server offers AI assistants.

  • Each API is versioned in its URL (for example /api/v1/), and every response carries an API-Version header naming the version that answered.
  • New fields, endpoints, optional parameters and webhook events can arrive at any time. They are not breaking changes, so build your tool to ignore fields it does not know.
  • A breaking change is announced at least 90 days before it takes effect.
  • When a new API version is released, the previous version keeps working at least 180 days afterwards.
  • A deprecated path answers with Deprecation and Sunset headers, so your tool can warn you before the date.

The policy and every live deprecation are served as JSON at /api/v1/api-policy/.

Changelogs

Each API keeps its own changelog, with every change and every retirement date:

SDK libraries

Our TypeScript and Python libraries are generated from the same API documents as the reference, so they cover exactly what each API offers.

  • The libraries take a new major version when an operation or field is removed or renamed.
  • They take a new minor version when an operation or field is added.
  • Only the current version can be downloaded, so reinstall it when an API changelog announces a change.

Download the current version, with install commands, from the developers page.

Can’t find what you’re looking for?

Our support team is here to help. Contact us and we’ll get back to you as soon as possible.

Contact us

We use cookies to improve your experience. See our Cookie policy (opens in a new tab) for details.