---
title: "Get events"
method: GET
path: "/v1/events"
tags: ["Billable events"]
---

# Get events

`GET /v1/events`

Retrieve billable events filtered by event type.

## Query parameters

- `take` number, nullable
- `skip` number, nullable
- `order` 'asc' | 'desc' — Sort direction.
- `sort` 'timestamp' — Field used to sort the results.
- `event_type` string, required — Event type to filter by
- `customer_id` string — Filter by customer ID
- `record_id__in` string — Filter by record ID. Supports comma-separated list for multiple records.
- `timestamp_gte` string, date-time — Filter events with timestamp greater than or equal to this ISO8601 date.
- `timestamp_lte` string, date-time — Filter events with timestamp less than or equal to this ISO8601 date.

## Response `200`

- PaginatedEvent
  - `meta` object, required
    - `total` number, required — Total of existing items.
    - `taken` number, required — Number of items returned.
    - `skipped` number, required — Number of items skipped.
  - `data` object[], required — List of Event.
    - `id` string, required — Event ID in Hyperline.
    - `event_type` string, required — Type of the event, as defined when ingesting events.
    - `timestamp` string, required — Timestamp of when the event occurred.
    - `customer_id` string, nullable, required — ID of the customer associated with this event.
    - `record_id` string, required — External record ID provided when ingesting the event.
    - `record` object, required — JSON payload of the event record.

---

[API](https://skmtc.dev/hyperline/apis/hyperline-api.md) · [All operations](https://skmtc.dev/hyperline/apis/hyperline-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hyperline/hyperline-api/revisions/19fa5f22e39b/schema)