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

Sandbox APIs are always on the latest version and previous versions are inaccessible. However, in some APIs, by specifying a version in a request, you can get responses as per the specified version of the API. This can be done via the x-api-version header.


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


API deprecation is the practice of gradually retiring an API. This typically happens when major changes are introduced, rendering the previous version less optimal. Once deprecated, the older version is no longer actively maintained. Developers are encouraged to migrate to the newer version or explore alternative APIs suggested in the changelogs.


The deprecated APIs are eventually discontinued in a planned manner. Post the dates communicated, the API will no longer work and you'll get Service Unavailable responses on the same. The dates will be communicated in the changelogs, via emails as well on the API Reference pages.