Stable

Versioning

API generation, backward-compatibility rules, and the deprecation policy.

The current API generation is V4. Endpoint paths carry no version prefix; the version is a generation label. The versioning approach lets the API evolve without breaking existing integrations.

Backward compatibility

Additive changes — new endpoints, new optional request fields, new response fields — are non-breaking and may be released within V4. A breaking change is introduced only as a new major generation.

Forward-compatible clients

Write your integration to be forward-compatible: ignore unknown response fields and do not depend on field order. A client written this way keeps working across additive changes.

The single source of truth for the API contract is openapi.json, and it is updated before any API change ships.

Deprecation

When an endpoint or field is to be deprecated, it is announced before removal. Existing integrations keep working through the announced transition period.