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

Listing Events

Get a list of Events, reverse ordered by timestamp. Use parameters to filter the list.

HTTP Request

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

Examples

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

# Get all undelivered Events
curl -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/events?is_delivered=false'

Query Parameters

Response

Returns a EventListing object containing a list of Event 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
{
    "events": [
        {"uid": "12837438", "type": ...},
        {"uid": "12837438", "type": ...},
        ...
    ],
    "next": null,
}

EventListing

This is the object that contains the Event 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 EventListing
{
    "events": [...],
    "next": null,
}

HTTP Response Codes