Skip to main content

API versioning

Current version

All public REST endpoints use the /v1 prefix:

https://api.catazenta.com/v1/...

MCP is versioned independently at:

https://api.catazenta.com/mcp

Stability policy

Change typePolicy
Additive (new fields, endpoints, optional params)Allowed in /v1 without a version bump
Breaking (remove field, rename, change semantics)Requires new major version (/v2) and notice
DeprecationDocumented in changelog; minimum 90 days notice for integrators before removal

OpenAPI specs

Download current contracts from OpenAPI downloads. Pin a copy in your CI and diff on upgrade.

  1. Ignore unknown JSON fields (forward compatibility).
  2. Use pagination — do not assume fixed page sizes.
  3. Handle 401 with token refresh.
  4. Poll jobs for long-running import/export; do not block HTTP clients.
  5. Subscribe to changelog and test in a non-production tenant before production cutover.

Questions

Contact CataZenta for deprecation timelines or extended compatibility windows.