Skip to main content
GET
/
meters
List Meters
curl --request GET \
  --url https://v1.api.flux-os.com/meters \
  --header 'x-api-key: <api-key>' \
  --header 'x-user-id: <api-key>'
{
  "data": [
    {
      "external_id": "<string>",
      "operator": "<unknown>",
      "id": "<string>",
      "facility": "<unknown>"
    }
  ],
  "meta": {
    "current_page": 123,
    "total_pages": 123,
    "total_items": 123,
    "per_page": 123
  }
}

Authorizations

x-api-key
string
header
required
x-user-id
string
header
required

Query Parameters

page
integer
default:1

Page number for pagination

Required range: x >= 1
regulator_id
string

Filter by regulator ID (searches across connected facilities)

facility_id
integer

Filter by facility ID

operator_id
integer

Filter by operator ID

external_id
string

Filter by external ID

Response

A list of meters.

data
object[]
meta
object