Sign in

v6

latestOpenAPI 3.1.02026-07-311856741.1 MB
customer_portal
customer_meters
public

List Meters

List meters of the authenticated customer.

Scopes: customer_portal:read customer_portal:write

get/v1/customer-portal/meters/

Query parameters

string uuid4

The meter ID.

OR
string[]

Filter by meter ID.

querystring nullable

Filter by meter name.

Filter by meter name.

pageinteger

Page number, defaults to 1.

Page number, defaults to 1.

limitinteger

Size of a page, defaults to 10. Maximum is 100.

Size of a page, defaults to 10. Maximum is 100.

sortingCustomerCustomerMeterSortProperty[] nullable

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.

Response

Successful Response

Example response

{
  "items": [
    {
      "customer_id": "992fae2a-2a17-4b7a-8d9e-e287cf90131b",
      "meter_id": "d498a884-e2cd-4d3e-8002-f536468a8b22",
      "consumed_units": 25,
      "credited_units": 100,
      "balance": 75
    }
  ]
}