Versioning and compatibility

Understand compatibility commitments and how breaking changes are communicated.

Current status

API v2 is currently private beta according to the generated contract. Provisioned clients may use it, while API v1 remains supported.

Compatible changes

Additive fields and endpoints may arrive without a new major version. Clients should ignore unknown response properties and must not depend on JSON property ordering.

Breaking changes

Breaking changes require a versioned replacement, migration guidance, and a documented observation window before removal.

Checking API access

Loading your activation state.