GET/api/v1/projects/{project_id}/suppressions
list_suppressions
Lists the project’s suppressions by address, then scope, at most 100 per call, or those of one address (email).
- Call it
- to see why an address gets no mail, or to page through the suppression list.
- Needs
- an admin key with
project_id, or a project key with scoperead(its own project; the argument is ignored). - Returns
itemsandnext_cursor: pass it ascursorfor the next page; null on the last page. The same asGET /api/v1/projects/{project_id}/suppressions.
Arguments
- object
-
cursorstring | nullnext_cursorof the previous page; leave it out for the first. -
emailstring | nullOnly this address; left out: every address.
example
ann@example.com -
limitinteger · int64 | nullPage size, 1 to 100; default 50.
1–100
-
project_idstring · uuid | nullThe project. An admin key must pass it; a project key’s own project is used and this is ignored.
No other arguments are accepted.
Result
The result comes back as structuredContent, with the same JSON as a text block.
- object · all fields required
-
itemsarray of SuppressionBy address, then by scope.
6 fields
- Suppression object · all fields required
-
created_atstring · date-time -
emailstring · email -
project_idstring · uuidThe suppression’s project.
-
reasonstringunsubscribed_all,unsubscribed_list,hard_bounce,soft_bounce_limit,complaintormanual. -
scopestringproject(every list) orlist:<list_id>. -
sourcestringWhere it came from:
api(the API or MCP),web,deliveryorinbound.
-
next_cursorstring | nullPass as
cursorfor the next page;nullon the last page.
Definitions
Suppression
An address on the project’s suppression list (GET /api/v1/projects/{project_id}/suppressions, an item).
- object · all fields required
-
created_atstring · date-time -
emailstring · email -
project_idstring · uuidThe suppression’s project.
-
reasonstringunsubscribed_all,unsubscribed_list,hard_bounce,soft_bounce_limit,complaintormanual. -
scopestringproject(every list) orlist:<list_id>. -
sourcestringWhere it came from:
api(the API or MCP),web,deliveryorinbound.
Errors
A failed call answers isError: true with a code from the same table as the HTTP API, and detail. How tools report errors
HTTP API
The same operation over HTTP: GET /api/v1/projects/{project_id}/suppressions