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 a paginated list of suppressed email addresses for the workspace. Use the email parameter for exact-match lookup of a single address.
Paramètres de requête
email
string
Email prefix filter. Returns all suppressions whose address starts with the supplied value (case-insensitive). A complete address returns only that address; a partial value such as "alice" returns all matches. May return multiple records when different reasons or scopes apply to the same address.
reason
string
Filter by suppression reason.
scope_type
string
Filter by scope type. Suppressions are currently workspace-scoped.
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.
Contenu de la réponse
data
array of object
obligatoire
Afficher les attributs enfants
data.id
string
obligatoire
data.email
string
obligatoire
data.scope
object
obligatoire
Afficher les attributs enfants
data.scope.type
string
obligatoire
The scope this suppression applies to. Suppressions are currently workspace-scoped; the other scope types are reserved for future use.
data.scope.id
string
obligatoire
Public ID or alias of the scoped resource. For workspace scope, this is the workspace ID (ws_ prefix).
data.reason
string
obligatoire
data.origin
string
obligatoire
data.applies_to
string
obligatoire
Blocking policy. "all" blocks every category. "non_transactional" blocks marketing and future non-transactional categories but allows transactional. "category" is reserved for category-specific preferences.
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
obligatoire
next_cursor
nullable string
obligatoire
Cursor for the next page. Pass back as starting_after to advance forward. Null when no next page exists.
prev_cursor
nullable string
obligatoire
Cursor for the previous page. Pass back as ending_before to step backward. Null when no previous page exists.
refresh_cursor
nullable string
obligatoire
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.