Current Version
The Contazen API is currently at version v1, which is included in all API URLs:Version Header
Every API response includes the version in the metadata:Stability
The v1 API is stable and production-ready. We are committed to maintaining backward compatibility for all v1 endpoints.Backward Compatible Changes
We may add the following without changing the API version:Additions
- New endpoints
- New optional parameters
- New response fields
- Additional functionality
Extensions
- Additional error codes
- Extended enum values
- New status types
- Enhanced features
Breaking Changes
If we need to make breaking changes in the future, we will:- Release a new API version (v2)
- Maintain v1 alongside the new version
- Provide clear migration documentation
- Give advance notice to all API users
- Removing endpoints or required parameters
- Changing response structure
- Modifying authentication methods
- Altering core business logic
Best Practices
Handle Unknown Fields
Handle Unknown Fields
Your integration should gracefully handle new fields in API responses. Don’t use strict parsing that fails when encountering unknown fields.
Check Response Status
Check Response Status
Always check the HTTP status code and the
success
field in responses. Don’t assume requests succeeded.Stay Informed
Stay Informed
Monitor your registered email for any API updates or announcements.