イベント回収API
発注・請求の業務イベント（Webhookイベント一覧の「発注・請求のイベント」）を、起きた順の連番で取得するAPIです。Webhook と同じ本文を返すので、 受信側が止まっていた間のイベントをここで取り直せます。Webhook を使わずに定期的に読みに来る使い方もできます。
GET /api/v1/events
発注・請求の業務イベントを古い順に取得します。Webhook を取りこぼしたときの回収に使います。
必要なスコープ: events:read
| パラメータ | 型 | 説明 |
|---|---|---|
starting_after | string | 前回の応答の next_cursor（連番）。省略すると保持期間の最初から返します |
limit | number | 1回に返す件数（既定: 50 / 最大: 100） |
type | string | イベントの種類で絞り込み（例: order.sent） |
レスポンス
{
"object": "list",
"data": [
{
"id": "evt_5c1e9a2f7b3d4e6a8c0f1b2d",
"object": "event",
"type": "order.sent",
"api_version": "2026-11-01",
"created": "2026-11-05T03:00:00.000Z",
"organization_id": "clxxx...",
"livemode": true,
"data": {
"object": { "object": "order", "id": "clxxx...", "status": "ORDERED", "sent_at": "2026-11-05T03:00:00.000Z", "channel": "EMAIL" },
"previous": { "sent_at": null }
},
"actor": { "type": "user", "name": "制作進行A" }
}
],
"has_more": false,
"next_cursor": "1042"
}- ●返すのはキーのスコープで読める種類だけです（orders:read → order.*、invoices:read → invoice.* / payment.*）。
- ●サンドボックス組織（テスト用キー at_test_…）のイベントは livemode が false です。
- ●next_cursor は毎回返します。次の呼び出しで starting_after に渡すと、その後に起きたイベントだけが返ります。
- ●書き込み中の処理の分だけ、連番が数秒〜数分遅れて埋まることがあります。取りこぼしたくない場合は少し前のカーソルから重ねて読み、id で重複を除いてください。
- ●保持期間は30日です。それより古いイベントは返りません。