Skip to main content

Compatibility and API changelog

Compatibility policy​

Only operations in the v1 endpoint reference are supported for external integrations. Existing unversioned /api/ routes belong to the web application and can change independently.

Additive fields and new operations can ship within v1. Clients should tolerate unknown response fields and handle optional or permission-restricted values. Breaking changes to the supported contract require a new API version and migration guidance. Changes are reviewed through the OpenAPI diff and recorded here.

The API remains support-approved beta until the staging acceptance checks and operational review are complete. Publishing a reference does not enable workspace access.

19 October 2026 — Initial beta implementation​

  • Added versioned workspace/project routes and an explicit supported-operation registry.
  • Added free, independent service accounts and scoped workspace API-key authentication.
  • Added workspace access approval, key/account suspension and revocation, shared quotas, idempotent POST requests, and request IDs.
  • Added generated OpenAPI, searchable reference, endpoint inventory, coverage matrix, and Postman collection.
  • Retained the internal schema separately for staff.
  • Corrected contact auditing, role-based partner/diary/event writes, and public compliance links; added workspace unit lookup and corrected nullable/computed response fields and asynchronous file finalisation.