Versioning

Your API version controls the behavior of the API, such as which request parameters are accepted, which response fields are returned, and other functional details.

To specify an API version, include the x-api-version header in your request with the desired version date.

Example:

x-api-version: 2025-03-06

Upgrade your API version

If you are using an older API version, we strongly recommend upgrading to the latest version to benefit from:

  • New features
  • Updated request/response schemas
  • Improved performance
  • Enhanced consistency and stability.

Available API Versions

Latest version: 2025-11-19

VersionRelease Notes / Migration Guide
2025-11-19migration to 2025-11-19
2025-03-06migration to 2025-03-06

Always review the migration guide before upgrading to make sure your integration remains compatible