Compteam API versioning and deprecation policy

Versioning and compatibility

The current REST API uses the /api/v1 URL prefix. Additive response fields can appear within this version; clients should ignore fields they do not use. Planned breaking contract changes use a new version or an explicitly documented migration before the affected operation is retired. Security corrections and enforcement of existing permissions can take effect immediately.

The OpenAPI specification names the configured API server explicitly. Use that server URL rather than assuming API operations live on the website host.

Deprecation notices

Deprecated operations are marked deprecated: true in OpenAPI. REST responses link to this policy using Link: rel="deprecation". When an operation has an announced deprecation date, its responses also carry the RFC 9745 Deprecation header as a structured date, such as @1767225600.

When a retirement date is set, the affected operation additionally returns Sunset as an HTTP date under RFC 8594. Deprecation is a migration notice; it does not itself disable an operation. The published date and migration instructions define that operation’s transition. No fixed minimum notice period or support lifetime is promised.

Current status and client behavior

No REST operations currently have an announced deprecation or retirement date. Active operations therefore do not send Deprecation or Sunset headers. Example header values on this page are illustrative.

Monitor OpenAPI for deprecated operations, follow the response’s policy link, and review the migration instructions before changing clients. Continue to enforce account selection and user confirmation; lifecycle notices do not expand permissions or make writes safe to repeat.

Compteam API documentation · OpenAPI specification · Integration support