List suppressions

The project’s suppressions by address, then scope, a page at a time; or those of one address (email, normalized). Needs scope read; an admin key may list any project’s.

Parameters

Name	In	Type	Description
`project_id`required	path	string · uuid	The project’s id
`email`	query	string	Only this address
`limit`	query	integer · int64 1–500	Page size, 1 to 500; default 50
`cursor`	query	string	`next_cursor` of the previous page

Request body

None.

Responses

200

One page

SuppressionList object · all fields required
itemsarray of Suppression

By address, then by scope.
6 fields
- Suppression object · all fields required
- created_atstring · date-time
- emailstring · email
  
  example ann@example.com
- project_idstring · uuid
  
  The suppression’s project.
- reasonstring
  
  unsubscribed_all, unsubscribed_list, hard_bounce, soft_bounce_limit, complaint or manual.
  
  example manual
- scopestring
  
  project (every list) or list:<list_id>.
  
  example project
- sourcestring
  
  Where it came from: api (the API or MCP), web, delivery or inbound.
  
  example api
next_cursorstring | null

Pass as cursor for the next page; null on the last page.

401

No valid key

Problem (application/problem+json)

403

A project key without scope read (forbidden)

Problem (application/problem+json)

404

No such project, or another project (not_found)

Problem (application/problem+json)

422

A parameter is invalid (validation_failed)

Problem (application/problem+json)

429

The key is over its rate limit, api.rate_limit_per_minute requests a minute on this node (rate_limited)

Header	Type	Description
`Retry-After`	integer	Seconds until the key’s next request passes; rounded up.

Problem (application/problem+json)

504

Postwind’s storage did not answer within its time limit (storage_timeout). A change the request makes may still take effect: check before repeating it. A repeat with the same Idempotency-Key never runs it twice: it is 409 idempotency_key_in_progress until the key’s 24 h end

Problem (application/problem+json)