Vital API
API documentation for Vital integrators. Access sensor data, manage devices, and integrate with the Vital irrigation platform.
API documentation for Vital integrators. Access sensor data, manage devices, and integrate with the Vital irrigation platform.
Integrator Resources
| Section | Description |
|---|---|
| Getting Started | Overview, base URL, and quick links |
| Authentication | Bearer tokens, API keys, and org scoping |
| Asset Endpoints | Application zones, locations, and devices (metadata) |
| Data Endpoints | Sensor time-series, irrigation, ET, and vegetation indices |
| Device Lifecycle | Activate, assign, and deactivate devices |
| Asset Workflow | Pump stations, application zones, and devices |
API Reference
Asset Endpoints (Metadata)
| Endpoint | Description |
|---|---|
| GET /api/v1/application_zones | List application zones (organization, pagination, total_count) |
| GET /api/v1/application_zones/{zone_id} | Single application zone detail |
| GET /api/v1/locations | List locations (pagination, status filter) |
| GET /api/v1/locations/{location_id} | Single location detail |
| GET /api/v1/devices | List devices (status, organization filter) |
Data Endpoints (Time-Series)
| Endpoint | Description |
|---|---|
| GET /api/v1/data/ | Sensor time-series and irrigation metrics by location |
| GET /api/v1/data/application_zones/ | Aggregated ET, irrigation, and vegetation indices by zone |
Support
Contact your Vital representative for API keys, base URLs, and integration support.