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 to our API v2, which will be released to production at a later date.

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 reflect the scope or impact of changes but is an indicator for an update occured. All changes remain fully backward-compatible within API version v2.

🚧

Purpose of API preview version

The API preview enables customers, partners, and integrators to prepare early for upcoming API extensions, in line with our continuously expanding feature set and related APIs. It also provides an opportunity to share valuable feedback with us. New endpoints and operations under development or testing are grouped at the top of each API section under the label "preview".

Please note that previews provided are not guaranteed to be stable and may change at any time before being finalized for production. For any production use, please refer exclusively to our API v2.