Capture API versioning and changes
Use the v1 contract and prepare for compatible, deprecated, or breaking changes.
- For
- Integration owners and developers
- Owner
- Integration engineering
- Outcome
- Keep the integration aligned with the supported version and customer-visible change record.
- Last verified
- 2026-08-30
- Next review
- 2026-11-28
- Status
- supported
The supported production base path is /api/v1/capture. The published OpenAPI document is the machine-readable contract for the approved operations.
Use the current contract
- Use only GET /info, POST /person, and POST /persons/bulk.
- Validate requests and responses against /openapi.json.
- Do not depend on internal application routes or undocumented response fields.
Prepare for change
- Assign an owner to review API release notes and deprecation notices.
- Test compatible changes in the customer integration before a planned rollout.
- Move to a new version before the published removal date for a breaking change.
- Keep the old path active only for the documented transition period.
Public change policy
- Compatible additions remain within the supported version when they do not change existing meaning.
- Breaking changes require a new version or an explicit migration and deprecation path.
- Security fixes can require a shorter action window when continued use is unsafe.
- Customer-visible API changes appear in the public release notes.