List Meters

List meters of the authenticated customer.

Scopes: customer_portal:read customer_portal:write

GET /v1/customer-portal/meters

List Meters

cURL

curl --request GET \
  --url https://api.spairehq.com/v1/customer-portal/meters/ \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "customer_id": "<string>",
      "meter_id": "<string>",
      "consumed_units": 123,
      "credited_units": 123,
      "balance": 123,
      "meter": {
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "name": "<string>"
      }
    }
  ],
  "pagination": {
    "total_count": 123,
    "max_page": 123
  }
}

Authorizations

customer_sessionmember_session

Authorization · string · header · required

Customer session tokens are specific tokens that are used to authenticate customers on your organization. You can create those sessions programmatically using the Create Customer Session endpoint.

Query Parameters

meter_id · string<uuid4> string<uuid4>[]

Filter by meter ID. The meter ID.

query · string | null

Filter by meter name.

page · integer · default: 1

Page number, defaults to 1.

limit · integer · default: 10

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

sorting · enum<string>[] | null

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.

Available options: created_at, -created_at, modified_at, -modified_at, meter_id, -meter_id, meter_name, -meter_name, consumed_units, -consumed_units, credited_units, -credited_units, balance, -balance

Response

200

application/json

Successful Response

items · CustomerCustomerMeter · object[] · required

Show child attributes

pagination · Pagination · object · required

Show child attributes