Skip to main content
GET
Get a meter

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.

meterId
string
required

Identifier of the meter. Get it from List meters. The value is case-sensitive.

Response

The meter.

_id
string

Meter identifier.

organizationId
string
createdAt
string
read-only

Date and time in UTC, with a numeric offset and no colon, for example 2026-10-28T13:51:31+0000.

Example:

"2026-10-28T13:51:31+0000"

updatedAt
string
read-only

Date and time in UTC, with a numeric offset and no colon, for example 2026-10-28T13:51:31+0000.

Example:

"2026-10-28T13:51:31+0000"

name
string

Name of the meter.

area
object
locatedIn
object

The space the meter is in.

building
object
canonicalType
string

Canonical type of the meter.

connector
object
fieldsInConnector
object
location
string
ontology
object
originType
enum<string>

How the meter was created: ORIGIN for a meter from a data source, VIRTUAL for a calculated meter, or MANUAL for a meter you add by hand.

Available options:
VIRTUAL,
ORIGIN,
MANUAL
references
object[]

Meters and devices this meter reads from.

spaceReferences
object[]

Spaces the meter serves or measures.

pointsCount
integer<int32>
points
object[]
areaServed
integer<int32>
installationDate
string<date>

Date the meter was installed.

Example:

"2022-03-10T00:00:00.000Z"

condition
string
serialNumber
string
model
string
description
string
vendor
string
manufacturer
string
status
enum<string>

ACTIVE, OUT_OF_SERVICE, or DECOMMISSIONED.

Available options:
ACTIVE,
OUT_OF_SERVICE,
DECOMMISSIONED
identifier
string

Your own identifier for the meter.

apiMeta
object
sourceForm
string
utilityAccountId
string
utilityProvider
string
utilityMeterId
string
meterReaderDeviceId
string
meterCategory
string
conversionFactor
number<double>
dataInterval
string
isMain
boolean

Whether this is the main meter of the building.

endUse
string