event

List events

Lists events, newest first: permits and cases filed on monitored places.

Events are listed whether or not a webhook takes them. Retrieve the record at data.href, which costs a credit.

get/v1/event

Request

  • Base URL: http://localhost:3030
  • URL: http://localhost:3030/v1/event
  • Auth: HTTP bearer

Query parameters

typestring[]

Only events of these types. Repeat for several.

min_createdstring date-time nullable

Only events created at or after this time, in ISO 8601.

cursorstring nullable

A cursor for pagination: the next_cursor from the previous page.

sizeinteger nullable

Number of results per page, between 1 and 200. Defaults to 20.

Response

A page of events.

object'list' required

The object's type. Always list.

has_moreboolean required

Whether there are more results after this page.

next_cursorstring nullable required

The cursor for the next page. Send it as cursor. Null on the last page.

suppressedinteger required

The number of matching results withheld because the plan does not include them.

Example response

{
  "data": [
    {
      "id": "evt_01h455vb4pex5vsknk084sn02q",
      "data": {
        "href": "/v1/permit/pmt_01h455vb4pex5vsknk084sn02q",
        "id": "pmt_01h455vb4pex5vsknk084sn02q",
        "list_item": "lsi_01h455vb4pex5vsknk084sn02q",
        "monitor": "mon_01h455vb4pex5vsknk084sn02q"
      },
      "href": "/v1/event/evt_01h455vb4pex5vsknk084sn02q"
    }
  ],
  "next_cursor": "eyJrIjoiMjAyNi0xMC0wMSIsInQiOjQyfQ"
}

Changes

No recorded changes to this operation across all 1 revision of this API.