API Versioning and Deprecation Policy

Setting of API Version

In order to use any of the API methods you will need to provide the version that you like to use.

This is done by appending the 'X-Api-Version' header on each request you make with the version number that you want.

Latest API Version: 3.0

Alternatively, you may use 'latest' keyword as version number in order to be served always with the latest version.


IMPORTANT: Organizations created prior to build 3.21.1

Before build 3.21.1, the definition of 'X-Api-Version' header was not necessary and API Version 1.0 was served as default version.

We keep this functionality unaffected for the organizations created prior to build 3.21.1, but issue may arise in case a newly created organization is used with your implementation.

It is strongly advised to include 'X-Api-Version' header to all your requests with the api version number of your choice, in order to avoid inconsistencies between organizations of an infrastructure.

Version format

API version numbers are in the format major.minor

The major version number changes if changes are made that are incompatible with the previous version

The minor version number changes if functionality is added in a backwards-compatible manner. We skip minor version number for the initial major versions, so there is no 1.0, 2.0 versions but 1, 2. 

The API Versions currently available are 1, 2, 2.1, 2.2, 3.0

Deprecation Policy

We support all versions of the API for at least 12 months after they are released. We recommend you move to the latest version as soon as you can after a release.

We will give customers 3 months' notice of when we deprecate a version of the API.