Tool
mail_suppression_list
List suppressed recipient addresses for the current product (paginated, filter by reason or address substring)
List suppressed recipient addresses for the current product (paginated, filter by reason or address substring)
Behavior
- HTTP
GET /mail/suppressions
Arguments
Name | Type | Required | Description |
|---|---|---|---|
q | string | — | Case-insensitive substring match on the address; omit for no address filter |
limit | integer | — | Max entries per page, 1-100 (default 50) |
cursor | string | — | Opaque pagination cursor from a prior page's next_cursor; omit for the first page |
reason | string | — | Only return entries suppressed for this reason; omit for every reason |
Response
Field | Type | Always | Description |
|---|---|---|---|
items | array | • | This page of suppression entries, newest first |
next_cursor | string | • | Opaque cursor to pass back as `cursor` for the next page; null on the last page |
Try it
List suppressed recipient addresses for the current product (paginated, filter by reason or address substring).