Appearance
Identifiers
Display names, hardware device IDs, database IDs, and data identifiers have different uses. Follow each API endpoint's path and field definitions rather than deriving an ID from a display name or URL fragment.
Organizations and projects
| Identifier | Where to find it | Use |
|---|---|---|
Organization slug | Organization ID in Settings → General | X-Organization-Slug request header and organization URLs |
Project project_id | Project card or basic settings | API project paths and project lookup |
The organization slug is set at creation and cannot be changed through basic settings. Renaming an organization or project does not change its identifier.
Devices
The device information area shows a device ID and an internal ID. API responses also include a numeric primary key, id.
| Field | Meaning | Example use |
|---|---|---|
serial_number | Hardware serial number; the device ID used when binding | Bind with the security code |
id | Numeric device primary key | Device endpoints such as /projects/{project_id}/devices/{id}/ |
agri_id | Internal device data identifier | Data association and routing |
Do not substitute agri_id for the numeric id required by a device endpoint. See the device API.
Points
Points have a numeric primary key, id, and an internal identifier, agri_id.
- Configuration, threshold, and control paths containing
/points/{id}/use the primary key required by that endpoint. - History and automation fields use
agri_idorpoint_agri_idas specified by the field definition. - Parse forwarding records according to their payload format; a field name or interface URL alone is not enough to infer its meaning.
A point's internal identifier relates to its device, slave, and register settings. After copying points, changing communication parameters, or transferring a device, check whether external systems still reference the original identifiers.
Before integrating
Copy identifiers from the platform or API and preserve their exact characters and case. Check the organization, project, device, and point together when testing a request. Do not reuse a primary key from another organization.
See the API field reference.
