TRANXACT.AI Help

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.

Type REST7 operationsBase path /api/crm/util-iot-devicesPublished as /api/v1/util-iot-devices

Download specification (OpenAPI 3.1) Screen: IoT Devices

Overview

PackageCRM
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tablecrm.util_iot_devices · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
device_labeltextYesLabel
meter_iduuidNoMeter
auth_modetextNoSigns with — hmac: an HMAC-SHA256 signature of each request. bearer: the key and secret as a token.
Allowed: hmac bearer both
statustextNoStatus
Allowed: active disabled retired
max_reads_per_minuteintegerNoReads per minute at most
firmwaretextNoFirmware
notestextNoNotes

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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
device_labeltextYesLabel
meter_iduuidNoMeter
auth_modetextNoSigns with — hmac: an HMAC-SHA256 signature of each request. bearer: the key and secret as a token.
Allowed: hmac bearer both
statustextNoStatus
Allowed: active disabled retired
max_reads_per_minuteintegerNoReads per minute at most
firmwaretextNoFirmware
notestextNoNotes

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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, withLines

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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
key_idtextread onlyKey id
device_labeltextread, writeLabel
meter_iduuidread, writeMeter
auth_modetextread, writeSigns with — hmac: an HMAC-SHA256 signature of each request. bearer: the key and secret as a token.
Allowed: hmac bearer both
secret_hashtextread onlySecret hash
secret_cipherbytearead onlySecret cipher
secret_last4textread onlySecret last4
secret_issued_attimestamp with time zoneread onlySecret issued at
statustextread, writeStatus
Allowed: active disabled retired
max_reads_per_minuteintegerread, writeReads per minute at most
last_seen_attimestamp with time zoneread onlyLast seen at
last_iptextread onlyLast ip
battery_pctnumericread onlyBattery pct
signal_dbmnumericread onlySignal dbm
firmwaretextread, writeFirmware
rejected_countintegerread onlyRejected count
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold CRM › IoT Devices for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.