Skip to main content
Use the x-version to force a specific version. Not providing a version, will result in the latest version.
Current version is 2024-1
Example:
We keep a current version-2 compatability timeframe. You must update within this to void breaking changes.

​
Breaking changes

Avoiding breaking changes is our most profound task when updating the API. Whilst we may update the API by introducing new endpoints, attributes or objects - we thrive to avoid breaking changes. Examples of breaking changes are:
  • Removing or renaming a parameter or field
  • Removing or renaming an endpoint or operation
  • Removing functionality from an endpoint
  • Adding stricter validation for a field
  • Changing error handling
If breaking changes are introduced, we will move to a new version. However, as stated, introducing non-breaking changes such as listed below, may not introduce a new version:

​
Non-breaking changes

  • Adding new endpoints or operations
  • Adding new fields to responses
  • Adding new optional request parameters
  • Changing field ordering in responses

​
Webhooks

Webhook don’t use default version. You can set the API version that you’d like to use when.