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

# Events List

`GET /api/v1/events/`

## Query parameters

- `page` integer, nullable — The page number from which to start (0-based)
- `limit` integer — The maximum number of items to return
- `search_fields` EventProperties[] — String names of fields to search. Correspond by index to search field values
- `search_field_values` string[] — Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list
- `order_by` 'timestamp' | 'session_id' | 'conversation_id' | 'source' | 'source_id' | 'category' | 'type' | 'user_id' | 'description' | 'attributes'
- `order_by_direction` 'asc' | 'desc' — The direction in which to order list results, either ascending or descending.
- `fields` EventProperties[], nullable — The fields to include in the response
- `start_datetime` string, nullable — The start datetime for filtering results
- `end_datetime` string, nullable — The end datetime for filtering results

## Response `200`

Successful Response

- ListResponseEvent
  - `items` Event[], required — List of items returned from the query
    - `timestamp` string, date-time, required — Timestamp at which the event occurred
    - `session_id` string, nullable — ID of the session in which the event occurred
    - `conversation_id` string, nullable — ID of the conversation associated with the session in which the event occurred
    - `source` string, nullable — Source of the event (either a tool call or an LLM prompt)
    - `source_id` string, nullable — ID of the source of the event (either a tool ID or a prompt ID)
    - `category` string, nullable — Broad categorization of the event
    - `type` string, nullable — More specific class of the event
    - `user_id` string, nullable — ID of the user interacting with the system when the event occurred (e.g., their phone number)
    - `description` string, nullable — Human-readable description of the event
    - `attributes` object, nullable — Arbitrary additional metadata for the event
  - `page` integer, required — The page number of the results (0-based)
  - `page_size` integer, required — The number of items returned per page
  - `total_pages` integer, nullable — The total number of pages of results given the indicated page size
  - `total_count` integer, nullable — The total number of items returned from the query

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/asksyllable/apis/syllablesdk.md) · [All operations](https://skmtc.net/asksyllable/apis/syllablesdk/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/asksyllable/syllablesdk/revisions/534f1f22c775/schema)