v1

latestOpenAPI 3.1.02026-07-1342111193.6 KB

Utility Meters (Beta)

List Utility Meters

Returns a paginated list of utility meters for all users, utility accounts, and service types. May be filtered by client_user_id, utility_account_id, and/or service_types to further refine results. Default ordered by descending updated_at.

get/utility_meters

Query parameters

client_user_idstring

A client_user_id to filter the list of returned items by.

utility_account_idinteger

A utility account id to filter the list of returned items by.

service_typesstring[]

A list of service types to filter the list of returns items by.

limitinteger

updated_afterstring date-time

ISO8601 datetime, used to traverse paginated responses. Use of this parameter is mutually exclusive with updated_before.

updated_beforestring date-time

ISO8601 datetime, used to traverse paginated responses. Use of this parameter is mutually exclusive with updated_after.

order'asc' | 'desc'

Used to specify the order in which records should be returned. Currently ordered by updated_at timestamp.

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Response

Success

total_countinteger required

Example response

{
  "data": [
    {
      "id": 12345,
      "client_user_id": "fff57dc7-3a2b-4395-8a62-e3486d46dabe",
      "utility_credential_id": 54321,
      "utility_account_id": 65432,
      "meter_number": "12300000045 67"
    }
  ],
  "total_count": 1
}