Management API is versioned. When backwards-incompatible changes are made to the API, we release a new, dated version. The current version is 2024-05-20.

Specifying API version is required to prevent breaking changes in the new versions breaking your integration. Any breaking changes will always be released in a new API version.

When making an API request, add X-API-Version HTTP header with the API version you’re using.

X-API-Version: 2024-05-20
curl -XGET -H 'Authorization: Bearer your-secret-api-key' -H 'X-API-Version: 2024-05-20' ''

Requests without a valid API version will return HTTP 400 error.

Before upgrading to a new API version, you should read the Changelog to understand what breaking changes are included and to learn more about how to upgrade to a new API version.