Skip to main content
GET
/
organizations
/
{orgId}
/
meters
List Meters
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/meters \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "version": 123,
      "customFields": {},
      "productId": "<string>",
      "groupId": "<string>",
      "name": "<string>",
      "code": "<string>",
      "dataFields": [
        {
          "category": "WHO",
          "code": "<string>",
          "name": "<string>",
          "unit": "<string>"
        }
      ],
      "derivedFields": [
        {
          "category": "WHO",
          "code": "<string>",
          "name": "<string>",
          "calculation": "<string>",
          "unit": "<string>"
        }
      ],
      "dtCreated": "2023-11-07T05:31:56Z",
      "dtLastModified": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedBy": "<string>"
    }
  ],
  "nextToken": "<string>"
}

Authorizations

​
Authorization
string
header
required

m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.

The authorizationCode flow controls access for human users via the m3ter Console application.

Path Parameters

​
orgId
string
required

UUID of the Organization. The Organization represents your company as a direct customer of the m3ter service.

Query Parameters

​
pageSize
integer<int32>

Number of Meters to retrieve per page.

Required range: 1 <= x <= 100
​
nextToken
string

nextToken for multi page retrievals.

​
productId
string[]

The UUIDs of the Products to retrieve Meters for.

​
ids
string[]

List of Meter IDs to retrieve.

​
codes
string[]

List of Meter codes to retrieve. These are the unique short codes that identify each Meter.

Response

List of Meters

​
data
object[]
​
nextToken
string