VITALAgronomics
Asset Endpoints

Devices Endpoint

Device metadata with assignment, telemetry status, and location context.

Endpoint: GET /api/v1/devices

Returns device metadata with assignment, telemetry status, and location context. Use this when listing sensor hubs, checking device health, or managing device assignments. Results are scoped to organizations the user can access.


Authentication

Requires authentication via Bearer token (Authorization: Bearer <JWT>) or API key (x-api-key header). Requires read permission. Bearer tokens use all organizations the user can access; API keys are organization-scoped.


List Devices

GET /api/v1/devices

Query Parameters

ParameterTypeRequiredDescription
statusstringNoFilter by status: active, inactive, or dormant. Omit to return all.
organization_idintegerNoFilter by organization. Omit to use all organizations the user can access. Must belong to user's orgs or returns 403.

Response

Returns an array of objects. Each object includes:

FieldTypeDescription
device_idintegerDevice identifier.
statusstringEffective status: active, inactive, or dormant. Devices with no telemetry in 24h are shown as inactive even if stored as active.
device_modelstringDevice model.
created_atstring | nullISO 8601.
updated_atstring | nullISO 8601.
current_location_idstringAssigned location UUID, or "Dormant device" if unassigned.
current_locationstringLocation display name, or "Dormant device" if unassigned.
current_application_zonestringZone name if assigned, or "Not assigned".
last_poststring | nullISO 8601 of last telemetry.
cell_barsinteger | nullLast cellular bars (0–5).
signal_strengthinteger | nullLast signal strength (dBm).
internal_tempnumber | nullLast internal temperature (°C).
supply_voltagenumber | nullLast supply voltage (V).
external_voltagenumber | nullLast external voltage (V).
gps[number, number] | null[latitude, longitude] from last telemetry.

Returns [] when no devices match.

On this page