Saltar para a documentação
API

Listar subscrições

As newsletters e as listas de distribuição que a caixa de correio recebe, tal como a página Subscrições as mostra.

GET/subscriptions

Executa a chamada real no seu espaço de trabalho.

GET /subscriptions

As newsletters e as listas de distribuição que a caixa de correio recebe, tal como a página Subscrições as mostra.

Exemplo

Requer threads:read. Um remetente é uma subscrição quando o seu correio traz um cabeçalho List-Unsubscribe, com uma linha por cada endereço para onde escreve. status é active, o valor por omissão, ou unsubscribed, q pesquisa o remetente, e sort é recent, most, unread ou name.

curl
curl "$OE/subscriptions?sort=most&limit=1" -H "$AUTH"
Resposta
{  "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 conta o correio dos últimos 30 dias, sinceUnsubscribed o correio que ainda chegou depois de ter cancelado a subscrição, e future indica a regra que continua a mover o correio novo do remetente, quando existe uma.

limit, 50 a menos que diga o contrário e no máximo 200, e offset percorrem as páginas. total conta todas as linhas que correspondem, e counts quantas estão ativas e quantas canceladas.

Uma chave ou uma aplicação limitada a certos endereços lista apenas as subscrições entregues a esses endereços, e address restringe a lista a um só endereço.

Referência