We follow the globally accepted semantic versioning for Sandbox API. Below is an example

TypeCompatibilityCurrent VersionNew Version
MajorBackward-non compatible1.
MinorNew functionality added, backward compatible2.
PatchBug-fix in the current version, backward compatible2.

Specifying API Version

By specifying a version in a request, you can get expected responses regardless of future changes to the API. This can be done via the x-api-version header.


API requests without any version specification go to the latest stable version.


Any major changes in the API are communicated in the Changelog while minor changes are communicated in the API Document. Major changes always lead to the previous version being deprecated and eventually discontinuance.


The dates for discontinuance are communicated in the Changelog and API Docs.