1. Documentation
2. API
3. Meters
4. List

Listing Meters

Get a list of Meters, reverse ordered by created date. Use parameters to filter the list.

HTTP Request

GET https://utilityapi.com/api/v2/meters

Examples

# Get a list of all Meters
curl -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/meters'

# Get some specific Meters 123 and 456
curl -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/meters?uids=123,456'

# Get all archived Meters
curl -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/meters?is_archived=true'

# Get the Meters that were created from a specific Authorization
curl -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/meters?authorizations=abcd1234'

# Get the Meters for a specific user
curl -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/meters?users=6744"

Query Parameters

Response

Returns a MeterListing object containing a list of Meter objects. If the number of results is over 1000, a next parameter will have the link to the next in the series of lists.

// Example result
{
    "meters": [
        {"uid": "12837438", "created": ...},
        {"uid": "12837438", "created": ...},
        ...
    ],
    "next": null,
}

MeterListing

This is the object that contains the Meter results for the request. We don't just return a straight list of results so that we can paginate results if needed. Currently, the maximum results per request is set at 1000.

// Example MeterListing
{
    "meters": [...],
    "next": null,
}

HTTP Response Codes