Field Reference

Overview

This glossary lists recurring identifiers and fields across API v2. Use it when reading endpoint specifications to keep names consistent in your integrations.

Organization

Field	Description	Example
slug	Organization identifier used in URLs and access tokens. Lowercase, unique per tenant.	yengear

Projects

Field	Description	Example
project_id	Public identifier for a project. Appears in URLs: /projects/{project_id}/....	proj_xxxx

Devices

Field	Description	Example
id	Internal integer primary key for a device. Used as {device_pk} in nested routes.	128
serial_number	Hardware identifier (IMEI, SN). Used when binding devices via safe code.	868686000123456
agri_id (device)	Platform-generated string ID assigned when the device is created. Prefix for factor IDs.	d-1000-abcd

Factors

Field	Description	Example
id	Internal integer primary key for a device. Used as {factor_pk} in nested routes.	1
unit	Modbus slave ID (integer).	1
address	Register address (integer).	0
data_index	Offset used when reading multiple registers.	0
modbus_type	Register type (holding, input, coil, discrete).	holding
data_type	Encoding for the register value (int16, uint32, float, etc.).	int16
data_endian	Byte order (ABCD, DCBA, BADC, CDAB).	ABCD
data_factor	Multiplier applied to raw data.	0.1
data_delta	Additive offset applied after scaling.	-10
the_type	Logical factor type, matching definitions from /base/device-types/.	temp
the_type_detail	Expanded metadata for the_type (name, unit, icon).	{ "name": "Temperature", "unit": "℃" }
agri_id (factor)	Full factor identifier	d-1000-abcd-1-000

Data Payloads

Field	Description	Example
t	UTC timestamp in seconds.	1708070400
value / v	Numeric reading for a factor. Some endpoints use value, others use v.	25.6
project_id	Injected into POST /devices/{device_pk}/data/ responses to show source project.	proj_xxxx
org_slug	Injected into POST /devices/{device_pk}/data/ responses to show owning organization.	yengear