OpenAPI Specification (OAS)

Here you can find all preview versions of our OAS files (OpenAPI Specification) to download:

📘

API version & release tag

The OpenAPI Specification provided here is a preview of upcoming extensions in our API v2 to be released at some time later to production.

Every OAS file available refers to this version as v2-preview, suffixed by a release tag indicating ongoing changes to that specific OAS file (e.g. v2-preview-1.1.0). The release tag does not express any degree of API change but is an indicator for an update only as all changes are anyhow implemented backwards-compatible within that API version v2.

🚧

Purpose of API preview version

The preview allows customers, partners and integrators to prepare for API extensions early with regard to our continuously growing set of features and related APIs and to provide valuable feedback to us.

Please keep in mind, the preview version is not guaranteed to be stable and subject to change at any time before being finally moved to production. Please make use of our API v2 only for any productive usage.