Getting Started
Welcome to the Vital API. This guide helps integrators connect to our data and device management endpoints.
Welcome to the Vital API. This guide helps integrators connect to our data and device management endpoints.
Overview
The Vital API provides:
- Data endpoints — Time-series sensor data, irrigation metrics, ET, and vegetation indices by location or application zone.
- Device lifecycle — Activate, assign, and deactivate sensor hubs.
- Asset workflow — Pump stations, application zones, and devices.
All endpoints require authentication and enforce organization-scoped access.
Base URL
https://production-api.app-vital.com/api/v1/
(Use your deployment's base URL for non-production.)
Quick Links
| Resource | Description |
|---|---|
| Authentication | Bearer tokens, API keys, and org-scoped access |
| Asset Endpoints | Application zones, locations, and devices (metadata) |
| Data Endpoint | Sensor time-series and irrigation metrics by location |
| Application Zones Data | Aggregated ET, irrigation, and vegetation indices by zone |
| Device Lifecycle | Activate, assign, and deactivate devices |
| Asset Workflow | Pump stations, application zones, and devices |
Common Use Cases
Fetching Data
- Authenticate with a Bearer token or API key.
- Call
GET /api/v1/data/orGET /api/v1/data/application_zones/. - Use
organization_idto scope results when needed. - See the Data Dictionary for field reference.
Device Onboarding
- Create a pump station and an application zone (see Asset Workflow).
- Activate the device via
POST /activate-device/. - Assign the location to the zone via
PUT /locations/{location_id}/. - Deactivate when removing:
POST /deactivate-device/.
Support
Contact your Vital representative for API keys, base URLs, and integration support.