Concepts
Versioning
The Renvo API uses URL-based versioning. The current version is v1.
URL prefix
All endpoints live under /api/v1/.... New major versions will live at /api/v2/... and so on.
Date-stamped releases
Within a major version, we publish dated revisions. The current revision is 2026-05-05. Backwards-incompatible changes within v1 will cut a new dated revision and the old behavior will be preserved for at least 12 months.
What counts as a breaking change?
- • Removing or renaming a field in a response.
- • Changing a field's type.
- • Removing an endpoint.
- • Changing the meaning of an existing query parameter.
Adding a new field, endpoint, or query parameter is not a breaking change. Always tolerate unknown fields in responses.
Pinning a version
Pin a specific revision by sending the Renvo-Version header:
Renvo-Version: 2026-05-05
Without the header, you get whatever the current default is for v1. Setting the header is recommended for production integrations.