Meter installations

Base URL: $BUSINESS_API

The object

idstring · required
tenant_idstring · required
connection_idstring · required
connection_holder_namestring · optional

Display name of the customer who holds the referenced connection. Omitted when unknown.

meter_idstring · required
meter_serialstring · optional

Serial number of the referenced meter. Omitted when unknown.

meter_holder_namestring · optional

Display name of the customer who holds the account the meter is installed on. Omitted when unknown.

account_idstring · optional
account_numberstring · optional

Number of the referenced account, e.g. CTA-000044. Omitted when unknown.

account_holder_namestring · optional

Display name of the customer who holds the referenced account. Omitted when unknown.

installed_atstring (date-time) · required
initial_readingstring · required
removed_atstring · optional · nullable
final_readingstring · optional
exchange_reasonstring · optional
installed_bystring · required
security_seal_numberstring · optional
replaced_installation_idstring · optional
idempotency_keystring · optional
created_atstring (date-time) · required
updated_atstring (date-time) · required
The object
{
  "id": "met_2yk9v6SNluyXngonlgs1hccPdGU",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "connection_id": "con_2wuJTWy9FOCTPGA3noGbHegbLaU",
  "connection_holder_name": "Ana Matsinhe",
  "meter_id": "mtr_21F02THKOD7uMpvUalZKsBv64nN",
  "meter_serial": "meter serial",
  "meter_holder_name": "Ana Matsinhe",
  "account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
  "account_number": "ACC-2026-000142",
  "account_holder_name": "Ana Matsinhe",
  "installed_at": "2026-11-19T09:30:00Z",
  "initial_reading": "initial reading",
  "removed_at": "2026-11-19T09:30:00Z",
  "final_reading": "final reading",
  "exchange_reason": "exchange reason",
  "installed_by": "installed by",
  "security_seal_number": "SEC-2026-000142",
  "replaced_installation_id": "rep_2rLgATXYm9pMiLbYyNLwCPHAGTv",
  "idempotency_key": "idempotency key",
  "created_at": "2026-11-19T09:30:00Z",
  "updated_at": "2026-11-19T09:30:00Z"
}

Installation history filtered by connection or meter

Logs

GET /meter-installations

Returns installation records (meter, connection, account, installation time, initial reading and seal number) across the tenant, with cursor pagination. With no filter every installation is returned. Requires the business:meters:read permission.

Parameters

connection_idstring · query · optional

Returns only installations on this connection.

meter_idstring · query · optional

Returns only installations of this meter.

openboolean · query · optional

When true or 1, returns only installations that are still in place (the meter has not been removed); any other value returns open and closed installations.

limitinteger · query · optional

Maximum resources to return (default 20, maximum 100).

afterstring · query · optional

Opaque cursor returned by the previous page.

Returns

200 Installations, newest first

Show attributes
dataarray of MeterInstallation · required
Show child attributes
idstring · required
tenant_idstring · required
connection_idstring · required
connection_holder_namestring · optional

Display name of the customer who holds the referenced connection. Omitted when unknown.

meter_idstring · required
meter_serialstring · optional

Serial number of the referenced meter. Omitted when unknown.

meter_holder_namestring · optional

Display name of the customer who holds the account the meter is installed on. Omitted when unknown.

account_idstring · optional
account_numberstring · optional

Number of the referenced account, e.g. CTA-000044. Omitted when unknown.

account_holder_namestring · optional

Display name of the customer who holds the referenced account. Omitted when unknown.

installed_atstring (date-time) · required
initial_readingstring · required
removed_atstring · optional · nullable
final_readingstring · optional
exchange_reasonstring · optional
installed_bystring · required
security_seal_numberstring · optional
replaced_installation_idstring · optional
idempotency_keystring · optional
created_atstring (date-time) · required
updated_atstring (date-time) · required
has_moreboolean · required
next_cursorstring · optional

Errors 400 · 403

Permissions business:meters:read · Roles: admin, analyst, billing_clerk, customer_service, field_reader, field_supervisor, operations, owner, viewer

curl -X GET "$BUSINESS_API/meter-installations" \
  -H "Authorization: Bearer sk_test_..."
Response 200
{
  "data": [
    {
      "id": "met_2yk9v6SNluyXngonlgs1hccPdGU",
      "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
      "connection_id": "con_2wuJTWy9FOCTPGA3noGbHegbLaU",
      "connection_holder_name": "Ana Matsinhe",
      "meter_id": "mtr_21F02THKOD7uMpvUalZKsBv64nN",
      "meter_serial": "meter serial",
      "meter_holder_name": "Ana Matsinhe",
      "account_id": "act_2JFioNDgIfvkgflk8RtcqhBaARP",
      "account_number": "ACC-2026-000142",
      "account_holder_name": "Ana Matsinhe",
      "installed_at": "2026-11-19T09:30:00Z",
      "initial_reading": "initial reading",
      "removed_at": "2026-11-19T09:30:00Z",
      "final_reading": "final reading",
      "exchange_reason": "exchange reason",
      "installed_by": "installed by",
      "security_seal_number": "SEC-2026-000142",
      "replaced_installation_id": "rep_2rLgATXYm9pMiLbYyNLwCPHAGTv",
      "idempotency_key": "idempotency key",
      "created_at": "2026-11-19T09:30:00Z",
      "updated_at": "2026-11-19T09:30:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "next cursor"
}