# イベントタイプの一覧

`GET /v1/event-types` · 権限 `events:read` · すべてのプラン

顧客のイベントカタログを返します。カタログには、Webhook エンドポイントが購読できるすべてのイベントタイプと、[イベント一覧](../events/list.md) が返せるすべてのイベントタイプが含まれます。各タイプには公開済みのスキーマバージョンが古い順に並び、高ボリュームかどうかも示されます。各タイプの人が読める形式のリファレンスは [イベント](/docs/events) にあります。

カタログはすべての環境で同じです。結果はタイプ名でソートされ、既定では降順です（昇順は `order=asc`）。カーソルによるページ単位で返されます。

## リクエスト

| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
| `limit` | query | いいえ | ページあたり 1〜100 件。既定値は 20。 |
| `after` | query | いいえ | `list_metadata.after` から得た前のページのカーソル。 |
| `before` | query | いいえ | `list_metadata.before` から得たカーソル。`after` と併用できません。 |
| `order` | query | いいえ | `desc`（既定）または `asc`。カーソルは、発行されたときと同じ並び順でのみ使用できます。 |

## レスポンス

`200 OK`。`list_metadata.after` は最後のページでは `null` になります。総件数は返されません。

| フィールド | 説明 |
|---|---|
| `type` | イベントタイプ（例: `user.created`）。 |
| `schema_versions` | 公開済みのスキーマバージョン（古い順）。各バージョンには `schema_version` と `schema_id` があり、`$id` はそのバージョンの JSON Schema です。`event_schema_versions` をタイプについて設定していない Webhook エンドポイントは、最初（最も古い）のバージョンを受け取ります。 |
| `high_volume` | `true` は、エンドポイントがすべてのタイプを購読する場合には含まれないタイプに付きます。名前を指定して選択してください（例: `authentication.succeeded`）。 |

```json
{
  "data": [
    {
      "type": "user.created",
      "schema_versions": [
        {"schema_version": 1, "schema_id": "https://docs.keenauth.com/events/user.created.v1.json"}
      ],
      "high_volume": false
    }
  ],
  "list_metadata": {"before": null, "after": "AQAMdXNlci5jcmVhdGVk"}
}
```

## エラー

| HTTP | code | 発生条件 |
|---|---|---|
| 400 | `invalid_cursor` | カーソルの形式が不正である、別の環境に属する、または別の並び順のものです。 |
| 422 | `validation_failed` | クエリパラメータが無効です（`/limit`、`/order`）。 |
| 401 | `unauthenticated` | 認証情報が見つからない、無効、または取り消されています。 |
| 403 | `insufficient_permissions` | 認証情報に `events:read` の権限がありません。 |
| 429 | `rate_limited` | レート制限を超えました。`Retry-After` の期間を置いてから再試行してください。 |

## 例

```bash
curl "https://api.eu.keenauth.com/v1/event-types?order=asc&limit=100" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"
```

CLI: `keenauth event-types list --order asc --limit 100`