---
title: "List Meters"
method: GET
path: "/v1/meters/"
tags: ["meters", "public"]
---

# List Meters

`GET /v1/meters/`

List meters.

**Scopes**: `meters:read` `meters:write`

## Query parameters

- `organization_id` union — Filter by organization ID.
  - string, uuid4 — The organization ID.
  - string[]
- `query` string, nullable — Filter by name.
- `is_archived` boolean, nullable — Filter on archived meters.
- `page` integer — Page number, defaults to 1.
- `limit` integer — Size of a page, defaults to 10. Maximum is 100.
- `sorting` MeterSortProperty[], 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.
- `metadata` MetadataQuery, nullable

## Response `200`

Successful Response

- ListResourceMeter
  - `items` Meter[], required
    - `metadata` MetadataOutputType, required
    - `created_at` string, date-time, required — Creation timestamp of the object.
    - `modified_at` string, date-time, nullable, required — Last modification timestamp of the object.
    - `id` string, uuid4, required — The ID of the object.
    - `name` string, required — The name of the meter. Will be shown on customer's invoices and usage.
    - `unit` 'scalar' | 'token' | 'custom', required
    - `custom_label` string, nullable — The label for the custom unit.
    - `custom_multiplier` integer, nullable — The multiplier to convert from base unit to display scale.
    - `filter` Filter, required
      - `conjunction` 'and' | 'or', required
      - `clauses` union[], required
        - union
          - FilterClause
            - `property` string, required
            - `operator` 'eq' | 'ne' | 'gt' | 'gte' | 'lt' | 'lte' | 'like' | 'not_like', required
            - `value` union, required
              - …
          - Filter — recursive
    - `aggregation` union, required — The aggregation to apply on the filtered events to calculate the meter.
      - CountAggregation
        - `func` 'count'
      - PropertyAggregation
        - `func` 'sum' | 'max' | 'min' | 'avg', required
        - `property` string, required
      - UniqueAggregation
        - `func` 'unique'
        - `property` string, required
    - `organization_id` string, uuid4, required — The ID of the organization owning the meter.
    - `archived_at` string, date-time, nullable — Whether the meter is archived and the time it was archived.
  - `pagination` Pagination, required
    - `total_count` integer, required
    - `max_page` integer, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/polar/apis/polar-api.md) · [All operations](https://skmtc.net/polar/apis/polar-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/polar/polar-api/revisions/77e4ef94fcc3/schema)