ドキュメント本文へスキップ
API

購読の一覧

「購読」ページに表示されるとおりの、メールボックスが受け取るニュースレターやメーリングリスト。

GET/subscriptions

実際の呼び出しをワークスペースに対して実行します。

GET /subscriptions

「購読」ページに表示されるとおりの、メールボックスが受け取るニュースレターやメーリングリスト。

例

threads:read が必要です。メールに List-Unsubscribe ヘッダーが付いている送信者が購読となり、送信先のアドレスごとに 1 行になります。status は active(既定)か unsubscribed、q は送信者を検索し、sort は recent、most、unread、name のいずれかです。

curl
curl "$OE/subscriptions?sort=most&limit=1" -H "$AUTH"
レスポンス
{  "object": "list",  "data": [{    "object": "subscription",    "id": "sub_5d2c8e17",    "senderEmail": "[email protected]",    "senderName": "Figma",    "recipient": "[email protected]",    "status": "active",    "method": "one-click",    "linkUrl": "https://www.figma.com/unsubscribe?u=4f1c",    "unread": 12,    "recent": 4,    "total": 58,    "sinceUnsubscribed": 0,    "lastSeenAt": "2026-10-01T07:02:41.000Z",    "unsubscribedAt": null,    "unsubscribedWith": null,    "future": null  }],  "total": 37,  "counts": { "active": 37, "unsubscribed": 9 },  "hasMore": true}

recent は直近 30 日のメールを、sinceUnsubscribed は購読を解除した後にも届いたメールを数え、future は新しいメールを移動し続けるルールがあれば、そのルールを示します。

limit(指定がなければ 50、最大 200)と offset でページを送ります。total は一致するすべての行を数え、counts は購読中と解除済みのそれぞれの数を示します。

特定のアドレスに限定されたキーやアプリは、そのアドレスに届く購読だけを一覧にし、address を指定すると 1 つのアドレスに絞り込みます。

リファレンス