List suppressions
GET
/v1/email/suppressions
curl -X GET "https://us1.platform.bird.com/v1/email/suppressions" \
-H "Authorization: Bearer $TOKEN" \
--url-query "email=user@example.com" \
--url-query "limit=25"Returns the workspace's suppressed email addresses as a paginated list, newest first. Pass a full address in the email parameter to look up a single address before sending to it.
An address can appear more than once: Bird keeps one suppression record per reason, and delivery stays blocked while any blocking record for the address remains.
Abfrageparameter
email
string
Case-insensitive prefix filter on the address: returns every suppression whose address starts with this value, so a full address finds that address's records and a fragment such as alice finds every address beginning with it. The same address can match several records, one per suppression reason.
reason
string
Return only suppressions with this reason: hard_bounce (delivery permanently failed), complaint (the recipient reported a message as spam), unsubscribe (the recipient opted out), or manual (added through the API or dashboard).
scope_type
string
Filter by scope type. Suppressions are currently always workspace-scoped; the other values are reserved for future use.
limit
integer
Maximum number of items to return per page.
starting_after
string
Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
ending_before
string
Cursor from the prev_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order.
Antwort-Payload
data
array of object
erforderlich
Page of suppression records.
Untergeordnete Attribute anzeigen
data.id
string
erforderlich
data.email
string
erforderlich
The suppressed address, stored lowercase.
data.scope
object
erforderlich
Untergeordnete Attribute anzeigen
data.scope.type
string
erforderlich
The scope this suppression applies to. Suppressions are currently workspace-scoped; the other scope types are reserved for future use.
Possible values: workspace, category, audience, topic, contact, domain
data.scope.id
string
erforderlich
Public ID or alias of the scoped resource. For workspace scope, this is the workspace ID (ws_-prefixed).
data.reason
string
erforderlich
Why the address is suppressed: hard_bounce (a delivery permanently failed), complaint (the recipient reported a message as spam), unsubscribe (the recipient opted out), or manual (added through the API or dashboard). An address can hold one record per reason. This list grows over time; treat unknown values as informational rather than rejecting the record.
Possible values (may grow over time): hard_bounce, complaint, unsubscribe, manual
data.origin
string
erforderlich
How the suppression came to exist: bounce_event (created automatically from a hard bounce), complaint_event (from a spam complaint), unsubscribe_event (from an unsubscribe reported for a message, such as the recipient's mail client's unsubscribe action), unsubscribe_link (the recipient opted out through the unsubscribe page linked from a message), api_key (added through the API with an API key), or user (added by a user in the dashboard). This list grows over time; treat unknown values as informational rather than rejecting the record.
Possible values (may grow over time): bounce_event, complaint_event, unsubscribe_event, unsubscribe_link, api_key, user
data.applies_to
string
erforderlich
Which sends the suppression blocks. all blocks every message category, including transactional. non_transactional blocks marketing and future non-transactional categories but allows transactional, so a recipient who complained or unsubscribed can still receive mail like password resets. category is reserved for category-specific preferences. This list grows over time; treat an unknown value as blocking at least non-transactional mail.
Possible values (may grow over time): all, non_transactional, category
data.source_email_id
nullable string
ID of the email that triggered suppression. Null for manual additions.
data.source_recipient_id
nullable string
ID of the recipient event that triggered suppression. Null for manual additions.
data.created_at
string
erforderlich
When the address was suppressed.
next_cursor
nullable string
erforderlich
Cursor for the next page. Pass back as starting_after to advance forward. Null when no next page exists.
prev_cursor
nullable string
erforderlich
Cursor for the previous page. Pass back as ending_before to step backward. Null when no previous page exists.
refresh_cursor
nullable string
erforderlich
Refresh anchor. Pass back as ending_before later to fetch items that have appeared since this response. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.