GEgetmaintainx
Meters

List meters

Changed on

Endpoint used to list meter resources

get/meters

Request

  • Base URL
    https://api.getmaintainx.com/v1
  • Auth
    HTTP bearer

Query parameters

cursorstring

Last pagination reference

limitinteger

max number of Meters returned

measurementType'MANUAL' | 'IOT_DEVICE' | 'AUTOMATED_SENSOR'

The measurement type of the meter to filter by

Example:MANUAL
assetsinteger[]

To filter by multiple asset IDs: assets=123&assets=456

expandstring[]

To expand multiple fields: expand=asset&expand=location

Headers

x-organization-idinteger

Required if using a multi organizations token

Response

Successfully fetched Meters list

nextCursorstring nullable required

The cursor to retrieve the next page of Meters.

nextPageUrlstring nullable required

Path with query parameters that can be used to retrieve the next page of Meters.

Example response

{
  "meters": [
    {
      "id": 123,
      "unit": "Celsius",
      "measurementType": "AUTOMATED_SENSOR",
      "asset": {
        "id": 963,
        "name": "Forklift",
        "description": "Forklift that is used to to move heavy equipments around the warehouse",
        "parentId": 852,
        "criticalityId": 150,
        "locationId": 852,
        "serialNumber": "000123ABC",
        "createdAt": "2022-01-01T00:00:00.000Z",
        "updatedAt": "2022-01-01T00:00:00.000Z",
        "creatorId": 851
      },
      "location": {
        "id": 963,
        "name": "Warehouses",
        "description": "The warehouse where we store the forklifts",
        "address": "1090 main street, Franklin",
        "parentId": 852,
        "createdAt": "2022-01-01T00:00:00.000Z",
        "updatedAt": "2022-01-01T00:00:00.000Z"
      },
      "lastReading": {
        "meterId": 53,
        "createdAt": "2022-01-01T00:00:00.000Z",
        "readingDate": "2022-01-01T00:00:00.000Z",
        "value": 120
      }
    }
  ]
}

Changes

  • 64746cdb0db4Revision changes
    • info

      the response property became required for the status

    • info

      the response property became required for the status

  • 222e6fad7c1fRevision changes
    • info

      added the new optional header request parameter x-organization-id

    • info

      added the new optional query request parameter assets

    • info

      added the new optional query request parameter measurementType

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      response property meters/items/lastReading/id list-of-types was narrowed by removing types number from media type application/json of response 200

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property // to the response with the status