API Versioning
Our versioning policy ensures stability while allowing us to evolve the API. We commit to long deprecation cycles and clear migration paths.
Our Versioning Promise
12-Month Support
Each API version is supported for at least 12 months after a new version is released.
6-Month Notice
We provide at least 6 months notice before sunsetting any API version.
Migration Guides
Every version includes comprehensive migration documentation and tooling.
API v2Current
Released June 1, 2024
Highlights
- New health risk assessment fields
- Expanded sustainability metrics
- Batch processing improvements
- Enhanced error responses with request_id
- Webhook signature verification
Types of Changes
Breaking Changes
Changes that require updates to your integration. These only occur in major version updates.
- •Removing or renaming fields
- •Changing field types
- •Removing endpoints
- •Changing authentication methods
- •Changing error response structure
Non-Breaking Changes
Additive changes that don't require updates. These can happen at any time.
- •Adding new optional fields
- •Adding new endpoints
- •Adding new enum values
- •Increasing rate limits
- •Improving error messages
Specifying API Version
Include the API version in the URL path. If omitted, the current version is used.
# Explicit version (recommended) https://api.justkalm.com/v2/valuate # Default to current version (not recommended for production) https://api.justkalm.com/valuate
Best Practice: Always specify the API version explicitly in production to avoid unexpected breaking changes when we release new versions.
Version Timeline
Stay Updated
Subscribe to our changelog for version updates and deprecation notices.