CRM · Utility Meters & Reads
IoT Devices
AMI and IoT endpoints that post their own reads: each with a key the server makes and a secret shown once, its health (last seen, battery, signal) and its alarms.
/api/crm/util-iot-devicesPublished as /api/v1/util-iot-devicesOverview
| Package | CRM |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold CRM › IoT Devices on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | crm.util_iot_devices · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
7 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/crm/util-iot-devicesList iot devices
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"key_id": "text",
"device_label": "text",
"meter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"auth_mode": "hmac",
"secret_hash": "text",
"secret_cipher": "text",
"secret_last4": "text",
"secret_issued_at": "2026-10-30T09:00:00Z",
"status": "active",
"max_reads_per_minute": 10,
"last_seen_at": "2026-10-30T09:00:00Z",
"last_ip": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/crm/util-iot-devices?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/util-iot-devices/{id}Read one iot device
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"key_id": "text",
"device_label": "text",
"meter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"auth_mode": "hmac",
"secret_hash": "text",
"secret_cipher": "text",
"secret_last4": "text",
"secret_issued_at": "2026-10-30T09:00:00Z",
"status": "active",
"max_reads_per_minute": 10,
"last_seen_at": "2026-10-30T09:00:00Z",
"last_ip": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/crm/util-iot-devices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/util-iot-devicesCreate a iot device
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
device_label | text | Yes | Label |
meter_id | uuid | No | Meter |
auth_mode | text | No | Signs with — hmac: an HMAC-SHA256 signature of each request. bearer: the key and secret as a token. Allowed: hmac bearer both |
status | text | No | Status Allowed: active disabled retired |
max_reads_per_minute | integer | No | Reads per minute at most |
firmware | text | No | Firmware |
notes | text | No | Notes |
Sample body
{
"device_label": "text",
"meter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"auth_mode": "hmac",
"status": "active",
"max_reads_per_minute": 10
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"key_id": "text",
"device_label": "text",
"meter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"auth_mode": "hmac",
"secret_hash": "text",
"secret_cipher": "text",
"secret_last4": "text",
"secret_issued_at": "2026-10-30T09:00:00Z",
"status": "active",
"max_reads_per_minute": 10,
"last_seen_at": "2026-10-30T09:00:00Z",
"last_ip": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/util-iot-devices" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"device_label":"text","meter_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","auth_mode":"hmac","status":"active","max_reads_per_minute":10}'PUT/api/crm/util-iot-devices/{id}Change a iot device
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
device_label | text | Yes | Label |
meter_id | uuid | No | Meter |
auth_mode | text | No | Signs with — hmac: an HMAC-SHA256 signature of each request. bearer: the key and secret as a token. Allowed: hmac bearer both |
status | text | No | Status Allowed: active disabled retired |
max_reads_per_minute | integer | No | Reads per minute at most |
firmware | text | No | Firmware |
notes | text | No | Notes |
Sample body
{
"device_label": "text",
"meter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"key_id": "text",
"device_label": "text",
"meter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"auth_mode": "hmac",
"secret_hash": "text",
"secret_cipher": "text",
"secret_last4": "text",
"secret_issued_at": "2026-10-30T09:00:00Z",
"status": "active",
"max_reads_per_minute": 10,
"last_seen_at": "2026-10-30T09:00:00Z",
"last_ip": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/crm/util-iot-devices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"device_label":"text","meter_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/crm/util-iot-devices/{id}Delete a iot device
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/crm/util-iot-devices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/util-iot-devices/{id}/rotate-secretRotate secret
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/util-iot-devices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/rotate-secret" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/util-iot-devices/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/util-iot-devices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'Data model
Every field of a iot device, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
key_id | text | read only | Key id |
device_label | text | read, write | Label |
meter_id | uuid | read, write | Meter |
auth_mode | text | read, write | Signs with — hmac: an HMAC-SHA256 signature of each request. bearer: the key and secret as a token. Allowed: hmac bearer both |
secret_hash | text | read only | Secret hash |
secret_cipher | bytea | read only | Secret cipher |
secret_last4 | text | read only | Secret last4 |
secret_issued_at | timestamp with time zone | read only | Secret issued at |
status | text | read, write | Status Allowed: active disabled retired |
max_reads_per_minute | integer | read, write | Reads per minute at most |
last_seen_at | timestamp with time zone | read only | Last seen at |
last_ip | text | read only | Last ip |
battery_pct | numeric | read only | Battery pct |
signal_dbm | numeric | read only | Signal dbm |
firmware | text | read, write | Firmware |
rejected_count | integer | read only | Rejected count |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold CRM › IoT Devices for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.