List readings

Time	Status	User Agent
Retrieving recent requests…

Time

Status

User Agent

Retrieving recent requests…

Retrieve a paginated list of meter readings that the authenticated user has access to.

Endpoint

GET /2.0/readings

Query Parameters

Pagination & Sorting

Parameter	Type	Default	Description
`limit`	number	`100`	Number of results per page
`page`	number	`1`	Page number (1-based)
`sort`	string	-	Sort field and direction. Format: `field:asc` or `field:desc` (e.g. `submittedAt:desc`)

Filters

Any field listed in the Reading object can be used as a query parameter to filter results.

Date range filters: Date fields support range operators using dot notation:

field.gte - Greater than or equal to
field.lte - Less than or equal to
field.gt - Greater than
field.lt - Less than

Example: submittedAt.gte=2024-01-01&submittedAt.lte=2024-12-31

Common filters:

Parameter	Type	Description
`accountId`	string	Filter by account (meter) ID
`entityId`	string	Filter by entity ID
`type`	string	Filter by reading type (default: `A`)
`source`	string	Filter by source: `manual`, `invoice`, `app`, `sub meter`
`units`	string	Filter by units (e.g. `kwh`, `m3`)
`isHalfHourly`	boolean	Filter half-hourly readings
`registerId`	string	Filter by register ID
`invoiceId`	string	Filter readings linked to a specific invoice

Response

{
  "total": 500,
  "limit": 100,
  "skip": 0,
  "data": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "submittedAt": "2024-01-15T09:30:00.000Z",
      "value": 60000,
      "type": "A",
      "units": "kwh",
      "name": "Monthly Read",
      "source": "manual",
      "registerId": "1",
      "accountId": "507f1f77bcf86cd799439012",
      "entityId": "507f1f77bcf86cd799439013",
      "companyId": "507f1f77bcf86cd799439014",
      "createdAt": "2024-01-15T10:00:00.000Z",
      "updatedAt": "2024-01-15T10:00:00.000Z"
    }
  ]
}

Example Request

curl -X GET "https://api.etainabl.com/2.0/readings?accountId=507f1f77bcf86cd799439012&submittedAt.gte=2024-01-01&sort=submittedAt:desc&limit=50" \
  -H "x-api-key: YOUR_API_KEY"

Scope Required

read:readings