Skip to main content
GET
List meters
Use the filters to narrow the list. A meter must match every filter you send. A filter value that matches nothing returns an empty page. originType and canonicalType must be supported values, in the exact letter case. An unsupported value returns 400.

Authorizations

Authorization
string
header
required

Paste an access token from Create an access token. Tokens expire, so request a new one if you receive 401.

Path Parameters

buildingId
string
required

Building identifier from List buildings.

Query Parameters

asc
string

Field to sort by, lowest first, for example name.

canonicalType
string[]

Return only meters of this canonical type. Repeat the parameter to match any of several types.

dsc
string
default:_id

Field to sort by, highest first. Defaults to _id.

identifier
string

Return only the meter with this identifier.

limit
integer<int32>
default:50

Number of items per page, from 1 to 200. The default is 50.

Required range: 1 <= x <= 200
originType
string

Return only meters with this origin: ORIGIN, VIRTUAL, or MANUAL.

page
integer<int32>
default:1

Page number to return. The first page is 1.

Required range: x >= 1
parentMeterId
string

Return only the child meters of this parent meter.

readingType
enum<string>

Return only meters with this reading type.

Available options:
REGISTERED_READING,
MONTHLY_CONSUMPTION
spaceLocatedId
string

Return only meters located in this space.

spaceReferenceId
string

Return only meters that reference this space.

Response

A page of meters. itemCount is the total number of meters that match the filters.

data
object[]
page
integer<int32>
limit
integer<int32>
pageCount
integer<int32>
itemCount
integer<int32>