Introducing versioning of Measure and Explore API
Overview
Regrow will begin versioning Measure and Explore API routes in 2025 to improve clarity, stability, and long-term user experience for our API consumers.
This introduces a version number directly in the API route (e.g., /v1/) to make version adoption easier and safer for you.
Why Versioning?
As our platform evolves, we occasionally make changes to how the API behaves — this may include updates to the request/response structure, business logic, or underlying models. By using versioned endpoints, we give you more control over when and how you adopt these changes, while maintaining backwards compatibility for existing integrations.
What’s Changing?
Instead of calling endpoints like:
- GET /inventory/projects
- POST /inventory/projects
You will now call:
- GET /v1/inventory/projects
- POST /v1/inventory/projects
Future versions will follow the same pattern:
- /v2/inventory/projects
- /v3/inventory/projects
What Do You Need to Do?
If you are integrating with our updated API version:
- Update your base route to include the desired version (e.g., /v1/).
- Everything else — endpoints, authentication, request structure — remains consistent with your current usage unless noted in the version-specific documentation.
If you are an existing customer and using the unversioned endpoints:
- No immediate action is needed.
- These will continue to function as they currently do, and we’ll provide advance notice before any future changes or deprecations.
Transition Plan
- /v0/ will represent our current legacy version
- Both the existing unversioned routes and the new versioned route v0 will be supported. Users can begin adding a prefix to their path to enable future transitions to v1, but this is not required.
- /v1/ introduces our latest updates.
- The first release will be for Explore API and Measure API Intervention Module
- Future updates will increment versions (e.g., /v2/, /v3/), with clear documentation and timelines provided.
Benefits to You
- Explicit Control: You choose when to adopt newer versions.
- Reduced Risk: Your existing integration remains stable, even as new functionality is introduced.
- Clear Documentation: Each version comes with its own set of docs and release notes.
- Predictable Upgrades: No surprise changes — you can review version updates and adopt them at your own pace.
Where to Find Version Info
Documentation and changelogs for each API version will be published alongside every release. You’ll find version-specific schemas, examples, and upgrade guidance clearly outlined.
Have questions or need help with the upgrade?
Reach out to your account representative or contact our support team. We’re here to ensure a smooth transition.