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

# List events

`GET /v1/events`

## Request

- Base URL: `https://api.yardstick.team`
- URL: `https://api.yardstick.team/v1/events`
- Auth: HTTP bearer

List events

**Required scopes:** `api_events:read`

**Example (curl):**

```bash
curl 'https://api.yardstick.team/v1/events?limit=20' \
  -H 'Authorization: Bearer ys_sk_live_…'
```

**Example (TypeScript):**

```ts
await fetch("https://api.yardstick.team/v1/events?limit=20", {
  headers: { Authorization: `Bearer ${process.env.YS_API_KEY}` },
}).then((r) => r.json());
```

## Query parameters

- `limit` integer
- `starting_after` string
- `type` string
- `created[gte]` string, date-time
- `created[lte]` string, date-time

## Headers

- `X-Request-Id` string

## Response `200`

Success

- object: Cursor-paginated list envelope.
  - `object` 'list', required
  - `data` Event[], required
    - `id` string, required: Display id, e.g. `evt_<base32>`
    - `object` 'event', required
    - `type` string, required: Stable event type, e.g. `person.created`
    - `created` string, required: ISO-8601 UTC
    - `livemode` boolean, required
    - `api_version` string, required: Pinned API version (YYYY-MM-DD)
    - `request_id` string, nullable, required: Correlation id for the request that produced this event — the same value returned in that request's `X-Request-Id` response header. Null for events written before the id was recorded, and for events produced outside an API request.
    - `data` object, required
  - `has_more` boolean, required

## Other responses

- `400`: Invalid request
- `401`: Authentication failure
- `403`: Permission denied (scope or feature flag)
- `404`: Resource not found. The error uses the resource-specific code and param names the exact body field or path parameter that referenced it.
- `409`: Conflict (e.g. idempotency key reuse with different body)
- `429`: Rate limited
- `500`: Internal error

---

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