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

# List events

`GET /events`

## Request

- Base URL: `https://public.escape.tech/v3`
- URL: `https://public.escape.tech/v3/events`
- Auth: API key in header `X-ESCAPE-API-KEY`

List and search events of the organization.

## Query parameters

- `cursor` string: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned.
- `size` integer: The number of items to return per page
- `sortType` 'DATE': The type to sort by
- `sortDirection` 'asc' | 'desc': The direction to sort by
- `search` string: Search term to filter events by name or description
- `after` string: Filter by after date
- `before` string: Filter by before date
- `scanIds` union: Filter by scan IDs
  - string
  - string[]
- `profileIds` union: Filter by profile IDs
  - string
  - string[]
- `assetIds` union: Filter by asset IDs
  - string
  - string[]
- `issueIds` union: Filter by issue IDs
  - string
  - string[]
- `eventIds` union: Filter by event IDs
  - string
  - string[]
- `targetIds` union: Filter by target IDs
  - string
  - string[]
- `workflowIds` union: Filter by workflow IDs
  - string
  - string[]
- `groups` union: Filter by groups
  - string
  - string[]
- `levels` string[]: Filter by level
- `stages` string[]: Filter by stage
- `severities` string[]: Filter by severity
- `risks` string[]: Filter by risk
- `scanProblemCodes` string[]: Filter by scan problem codes
- `responseStatusCodes` union: Filter by response status codes
  - string
  - union[]
    - union
      - string
      - number
- `hasAttachments` 'true' | 'false': Filter by attachments
- `attachments` string[]: Filter by attachments
- `public` 'true' | 'false': Filter by public events
- `dnf` string: Filter by DNF expression

## Response `200`

OK

- object
  - `nextCursor` string, nullable, required
  - `totalCount` integer
  - `data` object[], required
    - `id` string, uuid, required: The id of the event
    - `createdAt` string, required: The date and time the event was created
    - `title` string, required: The title of the event
    - `level` 'DEBUG' | 'ERROR' | 'INFO' | 'WARNING', required: The level of the event
    - `stage` 'AGENT_ACTION' | 'AGENT_REASONING' | 'CONFIGURATION' | 'EXECUTION', required: The stage of the event
    - `attachments` object[]: The attachments of the event
      - `id` string, uuid, required: The id of the attachment
      - `createdAt` string, required: The date and time the attachment was created
      - `target` object, nullable, required: The target of the attachment
        - `id` string, uuid, required: The id of the target
        - `createdAt` string, required: The date and time the target was created
        - `apiRoute` object, nullable, required: The api route of the target
          - `id` string, uuid, required: The id of the api route
          - `createdAt` string, required: The date and time the api route was created
          - `name` string, required: The name of the api route
          - `displayName` string, required: The display name of the api route
        - `codeFile` object, nullable, required: The code file of the target
          - `id` string, uuid, required: The id of the code file
          - `language` string, required: The language of the code file
          - `path` string, required: The path of the code file
        - `graphqlResolver` object, nullable, required: The graphql resolver of the target
          - `id` string, uuid, required: The id of the graphql resolver
          - `displayName` string, required: The display name of the graphql resolver
          - `name` string, required: The name of the graphql resolver
        - `port` object, nullable, required: The port of the target
          - `id` string, uuid, required: The id of the port
          - `port` number, required: The port number
          - `protocol` string, required: The protocol

## Other responses

- `400`: Pagination error

---

[API](https://skmtc.dev/escape/apis/escape-public-api.md) - [All operations](https://skmtc.dev/escape/apis/escape-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/escape/apis/escape-public-api/revisions/2eab35df40c7?raw)
