API Versioning

This guide outlines how to specify the required API version using the 'Accept' HTTP header when making requests to our API endpoints.

Understanding and effectively managing versions is crucial to maximize benefits from APIs. Our API versioning system is primarily governed through the 'Accept' HTTP header, which can be modified as required to access different versions.

How to Use API Versioning

When making a request to our API, specify the required API version in the 'Accept' HTTP header. Here is how you can do it:

Version 1 (Default Version)

If you want to use version 1, set your 'Accept' header to either 'application/json' or 'application/json;version=1'. Below are the examples:

Accept: application/json


Accept: application/json;version=1

Version 2 and Beyond

If you wish to use version 2 or any version beyond, indicate it in the 'Accept' header as 'application/json;version=2' for version 2, and so forth. Here is an example for version 2:

Accept: application/json;version=2

Things to Remember

  • Varied Endpoint Compatibility: Please note that not all endpoints support multiple versions. Consequently, use your preferred version wisely.

Last updated