---
title: "List events"
method: GET
path: "/v1/event"
tags: ["event"]
---

# List events

`GET /v1/event`

## Request

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

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.

## Query parameters

- `type` string[]: Only events of these types. Repeat for several.
- `min_created` string, date-time, nullable: Only events created at or after this time, in ISO 8601.
- `cursor` string, nullable: A cursor for pagination: the `next_cursor` from the previous page.
- `size` integer, nullable: Number of results per page, between 1 and 200. Defaults to 20.

## Response `200`

A page of events.

- CollectionEvent
  - `object` 'list', required: The object's type. Always `list`.
  - `data` Event[], required: The results on this page.
    - `object` 'event', required: The object's type. Always `event`.
    - `id` string, required: Unique identifier for the object.
    - `type` 'permit.created' | 'case.created', required: The event's type. One of `permit.created` or `case.created`.
    - `data` object, required: The event's payload, as webhooks receive it: the record's `id` and `href`, and the `monitor` and `list_item` it matched.
    - `created_at` string, date-time, required: Time at which the object was created.
    - `href` string, required: The object's path in the API.
  - `has_more` boolean, required: Whether there are more results after this page.
  - `next_cursor` string, nullable, required: The cursor for the next page. Send it as `cursor`. Null on the last page.
  - `suppressed` integer, required: The number of matching results withheld because the plan does not include them.
  - `total` Total, required: The number of matching results.
    - `value` integer, required: The number of matching results.
    - `relation` 'eq' | 'gte', required: One of `eq` (exact) or `gte` (at least `value`). Counts above 10,000 are `gte`.

## Other responses

- `401`: `credential_missing`, `credential_invalid` or `credential_expired`. The request has no valid credential.
- `403`: `scope_missing`, `person_required`, `api_key_not_accepted` or `entitlement_missing`. The credential or plan does not allow this request. `detail` names the reason.
- `422`: `parameter_invalid`, `id_malformed` or a cursor code. A parameter is missing or invalid. `errors` lists each one.
- `429`: `rate_limited`. Too many requests. Retry after the `Retry-After` interval. Nothing is charged.

---

[API](https://skmtc.dev/placestack/apis/placestack-api.md) · [All operations](https://skmtc.dev/placestack/apis/placestack-api/llms.txt) · [OpenAPI document](https://skmtc.dev/placestack/apis/placestack-api/revisions/0ccdf0882668?raw)