API Reference
Versioning and changes
Use the v1 contract and prepare for compatible or breaking changes.
- For
- Integration owners and developers
- Owner
- Integration engineering
- Outcome
- Keep an integration aligned with the supported API version.
- Last verified
- 2026-09-01
- Next review
- 2026-11-30
- Status
- Supported public contract
The current supported path is /api/v1/capture. The published OpenAPI document is the
machine-readable contract.
Change policy
- Compatible additions can remain in v1 when they do not change existing meaning.
- Breaking changes require a new version or a clear migration and deprecation path.
- Security fixes can require a shorter action window when continued use is unsafe.
- Customer-visible API changes appear in the changelog.
Do not depend on internal application routes or undocumented response fields.