get
https://api.etainabl.com/2.0/accounts
List all accounts/meters
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Retrieve a paginated list of accounts (meters) that the authenticated user has access to.
Endpoint
GET /2.0/accountsQuery 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. name:asc) |
Filters
Any field listed in the Account object can be used as a query parameter to filter results. Only fields returned in the API response can be used for filtering.
Date range filters: Date fields support range operators using dot notation:
field.gte- Greater than or equal tofield.lte- Less than or equal tofield.gt- Greater thanfield.lt- Less than
Common filters:
| Parameter | Type | Description |
|---|---|---|
name | string | Filter by account/meter name |
type | string | Filter by utility type (e.g. electricity, gas, water) |
status | string | Filter by status: active or inactive |
meterPointNumber | string | Filter by MPAN/MPRN |
meterSerialNumber | string | Filter by meter serial number |
meterUnits | string | Filter by meter units (e.g. kwh, m3) |
assetId | string | Filter by asset (site) ID |
entityId | string | Filter by entity ID |
isVirtual | boolean | Filter virtual/aggregated meters |
automaticMeterRead | boolean | Filter by automatic meter read capability |
tags | string | Filter by tag |
Response
{
"total": 50,
"limit": 100,
"skip": 0,
"data": [
{
"_id": "507f1f77bcf86cd799439011",
"name": "Main Electricity Meter",
"type": "electricity",
"meterPointNumber": "1234567890123",
"meterSerialNumber": "E12345678",
"meterUnits": "kwh",
"status": "active",
"automaticMeterRead": true,
"assetId": "507f1f77bcf86cd799439012",
"entityId": "507f1f77bcf86cd799439013",
"companyId": "507f1f77bcf86cd799439014",
"tags": ["main-meter"],
"createdAt": "2024-01-15T09:30:00.000Z",
"updatedAt": "2024-06-20T14:15:00.000Z"
}
]
}Example Request
curl -X GET "https://api.etainabl.com/2.0/accounts?type=electricity&status=active&assetId=507f1f77bcf86cd799439012&limit=50&sort=name:asc" \
-H "x-api-key: YOUR_API_KEY"Scope Required
read:accounts