Cellular

Cellular add-on: device registry, remote config, and outbound measurement webhooks.

List device config profiles

List configuration profiles created in Tempivo (Integrations → Config profiles). Use each profile's slug with GET /devices/config-profiles/{slug} and PUT …/apply. Creating or editing profile definitions via API is not supported.

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Bearer token with your API key. Example: Bearer sk_live_xxx

In: header

Response Body

`application/json`

curl -X GET "https://example.com/devices/config-profiles"

{
  "profiles": [
    {
      "slug": "weekday-low-temp",
      "name": "Weekday low temperature",
      "measurementPeriodBase": 3600,
      "measurementPeriodFactor": 1,
      "transmissionInterval": 21600
    },
    {
      "slug": "weekday-alarms",
      "name": "Weekday — low temperature alarm",
      "measurementPeriodBase": 300,
      "measurementPeriodFactor": 1,
      "transmissionInterval": 21600,
      "alarmRules": [
        {
          "slotNumbers": [
            0
          ],
          "condition": "LOW_THRESHOLD",
          "alarmRuleType": "TEMPERATURE",
          "threshold": 50,
          "hysteresis": 2,
          "action": "TRIGGER_TRANSMISSION"
        },
        {
          "condition": "DISABLED",
          "slotNumbers": [],
          "action": "NO_ACTION"
        },
        {
          "condition": "DISABLED",
          "slotNumbers": [],
          "action": "NO_ACTION"
        },
        {
          "condition": "DISABLED",
          "slotNumbers": [],
          "action": "NO_ACTION"
        },
        {
          "condition": "DISABLED",
          "slotNumbers": [],
          "action": "NO_ACTION"
        },
        {
          "condition": "DISABLED",
          "slotNumbers": [],
          "action": "NO_ACTION"
        },
        {
          "condition": "DISABLED",
          "slotNumbers": [],
          "action": "NO_ACTION"
        },
        {
          "condition": "DISABLED",
          "slotNumbers": [],
          "action": "NO_ACTION"
        },
        {
          "condition": "DISABLED",
          "slotNumbers": [],
          "action": "NO_ACTION"
        },
        {
          "condition": "DISABLED",
          "slotNumbers": [],
          "action": "NO_ACTION"
        },
        {
          "condition": "DISABLED",
          "slotNumbers": [],
          "action": "NO_ACTION"
        },
        {
          "condition": "DISABLED",
          "slotNumbers": [],
          "action": "NO_ACTION"
        }
      ],
      "calendars": [
        {
          "type": "WEEK",
          "enableRules": [
            0
          ],
          "days": [
            1,
            2,
            3,
            4,
            5
          ],
          "fromTime": 480,
          "toTime": 1080,
          "timezone": 60
        },
        {
          "type": "DISABLED",
          "enableRules": []
        },
        {
          "type": "DISABLED",
          "enableRules": []
        },
        {
          "type": "DISABLED",
          "enableRules": []
        },
        {
          "type": "DISABLED",
          "enableRules": []
        },
        {
          "type": "DISABLED",
          "enableRules": []
        }
      ]
    }
  ]
}

Empty

Get device config profile

Read a profile by slug (created in the Tempivo app). Use PUT …/apply to push it to devices.

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Bearer token with your API key. Example: Bearer sk_live_xxx

In: header

Path Parameters

slug*string

Response Body

`application/json`

curl -X GET "https://example.com/devices/config-profiles/string"

{
  "profile": {
    "slug": "weekday-low-temp",
    "name": "Weekday low temperature",
    "measurementPeriodBase": 3600,
    "measurementPeriodFactor": 1,
    "transmissionInterval": 21600
  }
}

Empty

Get device configuration state

Read pending configuration (after profile apply) and the latest configuration reported by the device. Use syncStatus to see whether profile settings have been applied: poll until pendingConfig is null and syncStatus is applied (or no_device_report if the device has not reported config yet).

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Bearer token with your API key. Example: Bearer sk_live_xxx

In: header

Path Parameters

serial*string

Device serial number

Response Body

`application/json`

curl -X GET "https://example.com/devices/string/config"

{
  "serialNumber": "SN001",
  "assetId": "asset-123",
  "assetName": "Hot water — Building A",
  "pendingConfig": null,
  "deviceConfig": {
    "measurementPeriodBase": 3600,
    "measurementPeriodFactor": 1,
    "transmissionInterval": 21600
  },
  "deviceConfigReceivedAt": "2026-03-17T10:00:00.000Z",
  "syncStatus": "applied"
}

Empty

Apply profile to devices

Merge the profile into pendingConfiguration for the given serial numbers or all active devices. Devices pick up changes on the next config poll.

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Bearer token with your API key. Example: Bearer sk_live_xxx

In: header

Path Parameters

slug*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Apply a profile to devices. Provide serialNumbers (non-empty) or applyToAll true, not both.

serialNumbers?array<string>

Device serial numbers to update

applyToAll?boolean

When true, apply to all active devices in the organization

Response Body

`application/json`

curl -X PUT "https://example.com/devices/config-profiles/string/apply" \  -H "Content-Type: application/json" \  -d '{    "serialNumbers": [      "SN001",      "SN002"    ]  }'

{
  "ok": true,
  "profileSlug": "weekday-low-temp",
  "appliedCount": 2,
  "applied": [
    "SN001",
    "SN002"
  ]
}

Empty

List assets

List devices in your organization. Paginate with cursor / nextCursor.

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Bearer token with your API key. Example: Bearer sk_live_xxx

In: header

Query Parameters

limit?integer

Max items per page

cursor?string

Last asset's id from the previous page: the same value returned as nextCursor (pass verbatim).

model?string

Optional filter by sensor product line (alias: model-name).

model-name?string

Deprecated alias for model query param.

Response Body

`application/json`

curl -X GET "https://example.com/assets"

{
  "items": [
    {
      "id": "asset-123",
      "recType": "asset",
      "name": "Unit 0042",
      "serialNumber": "DEVICE-123456789012",
      "status": "online",
      "signalStrength": "good",
      "batteryStatus": "ok",
      "model": "TVO-THT",
      "lastReadingAt": "2026-03-17T10:00:00.000Z"
    }
  ],
  "totalItems": 1,
  "nextCursor": "asset-123"
}

{
  "success": false,
  "message": "Invalid or inactive API key"
}

{
  "success": false,
  "message": "Invalid or inactive API key"
}

{
  "success": false,
  "message": "Invalid or inactive API key"
}

{
  "success": false,
  "message": "Invalid or inactive API key"
}

Create asset

Register a device (unique serialNumber among active assets). For integrator accounts, serialNumber and optional name are enough.

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Bearer token with your API key. Example: Bearer sk_live_xxx

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Register a device in your org. Cellular / integrator: omit buildingId when the org has a default building; use waterType automatic and floor 0 for a flat device list. Full REST (property): set buildingId (and optionally spaceId or floor) for building/room placement.

buildingId?string

Building ID (required for property customers; optional for integrator orgs with a configured default building)

spaceId?|

Room/space ID (property customers). Omit for integrator flat lists.

floor?integer

Use 0 for integrator flat placement when spaceId is omitted.

name?string

Display name (defaults to serial number or '–')

serialNumber?string

Device serial (min 12 chars). Must be unique among active assets only; re-use allowed if the previous holder was archived (soft-deleted).

iccid?string

1NCE SIM ICCID (optional)

model?|

Sensor product line (same field as GET /assets model). Set when known. JSON null for a measuring point without a device.

assetType?string

Outlet/asset type

waterType*string

pipeMaterial?string

For sensors only

pipeSize?string

For sensors only

image?string

Image URL or data URI

userId?|

Optional user ID to assign as owner

Response Body

`application/json`

curl -X POST "https://example.com/assets" \  -H "Content-Type: application/json" \  -d '{    "serialNumber": "DEVICE-123456789012",    "name": "Unit 0042",    "waterType": "automatic",    "floor": 0,    "model": "TVO-THT"  }'

{
  "id": "string"
}

{
  "success": false,
  "message": "Invalid or inactive API key"
}

{
  "success": false,
  "message": "Invalid or inactive API key"
}

{
  "success": false,
  "message": "Invalid or inactive API key"
}

Get asset

Retrieve one device by asset ID. Same API key as config profiles.

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Bearer token with your API key. Example: Bearer sk_live_xxx

In: header

Path Parameters

assetId*string

Response Body

`application/json`

curl -X GET "https://example.com/assets/string"

{
  "id": "asset-123",
  "recType": "asset",
  "name": "Unit 0042",
  "serialNumber": "DEVICE-123456789012",
  "status": "online",
  "signalStrength": "good",
  "batteryStatus": "ok",
  "model": "TVO-THT",
  "lastReadingAt": "2026-03-17T10:00:00.000Z"
}

{
  "success": false,
  "message": "Invalid or inactive API key"
}

Delete asset (soft)

Remove a device from your org (soft-delete: status → archived, assignments cleared). It disappears from list/get; measurement history is kept. No public restore — contact support if needed. Same API key as config profiles.

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Bearer token with your API key. Example: Bearer sk_live_xxx

In: header

Path Parameters

assetId*string

Response Body

`application/json`

curl -X DELETE "https://example.com/assets/string"

{
  "deleted": true
}

{
  "success": false,
  "message": "Invalid or inactive API key"
}

Replace device (serial)

Replace the physical device for an asset: set a new serial number and append the previous one to replacement history. All existing data (history, config, alerts) is kept. Cellular API organizations may use their API key here without the API integrations add-on (same key as config profiles).

Authorization

ApiKeyAuth

AuthorizationBearer <token>

Bearer token with your API key. Example: Bearer sk_live_xxx

In: header

Path Parameters

assetId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

newSerialNumber*string

New device serial number (replaces current; history is preserved)

probeMigration?string

Optional probe layout change when the new device has different ch3/ch4 wiring (single vs dual hot/cold or VVC inlet/return). Default keep.

Response Body

`application/json`

curl -X POST "https://example.com/assets/string/replace-hardware" \  -H "Content-Type: application/json" \  -d '{    "newSerialNumber": "DEVICE-987654321098"  }'

{
  "success": true,
  "serialNumber": "string"
}

{
  "success": false,
  "message": "Invalid or inactive API key"
}

{
  "success": false,
  "message": "Invalid or inactive API key"
}

{
  "success": false,
  "message": "Invalid or inactive API key"
}

Cellular

200application/json

403

200application/json

404

Intervals only (no alarms)

With alarmRules + calendars (12 + 6 slots)

200application/json

400

403

404

Applied (no pending queue)

Pending profile with alarmRules + calendars

200application/json

404

200application/json

400application/json

401application/json

403application/json

429application/json

201application/json

400application/json

403application/json

409application/json

200application/json

404application/json

200application/json

404application/json

200application/json

400application/json

404application/json

409application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`