Setting the version
Pass the version as a request header:2026-02-06). To pin your integration to a specific version, always send the header explicitly.
Versions
2026-02-06 — Current
The latest version. This is the default when no X-API-Version header is sent.
2026-01-01 — Previous
The previous stable version. Still supported — pass the header to continue receiving the old response structure.
A deprecation and sunset date for
2026-01-01 will be communicated with a minimum of 90 days notice via email and in these docs.Migrating from 2026-01-01 to 2026-02-06
To migrate, update your integration to handle the new response structure, then switch the header (or remove it to use the default).
If you need help identifying what changed for a specific endpoint, contact support.
Version errors
| Error code | HTTP status | Description |
|---|---|---|
error_auth_api_version_not_supported | 400 | The version string in X-API-Version does not match any known version. |
error_auth_api_version_not_available | 403 | The requested version exists but is not available to your account. |
error_auth_api_version_deprecated | 410 | The requested version has been discontinued. Migrate to a supported version. |
error_auth_api_version_locked | 403 | Your account is locked to a specific version. Contact support to change it. |
error_auth_api_version_access_denied | 403 | Your account does not have access to the requested version. |