The SkillEngine API is a date-based versioned API system, such that each integrator interacts with a certain version of our product. To know your own version, you can call the /version endpoint (description can be found here).

Your version is set by us at the time your tenant is created. This version controls how your API will behave (in terms of supported parameters, response formats, etc.).

As it is possible that we introduce breaking changes in future updates that may break your code, we will not update your version unless you specifically request this. Breaking changes will always be released under a new date and can be tracked in the documentation here.

Deprecations will be announced in the documentation and will be supported for a certain period of time. After this period, the deprecation will become a breaking change. Deprecations can be tracked in the documentation here.

Non-breaking changes, on the other hand, will be supported by your API, regardless of your version. An overview can also be found here.

In case you want to test a specific version of the API, e.g. when switching versions, you can add the header X-API-Version to your requests. The value of this header is the version of the API you want to use, for example 2021-03-19.

When you see an endpoint marked with Experimental it is considered experimental or in beta. These endpoints can undergo breaking changes without any notice or promises on backwards compatibility. You should not use them in production.