email-suppressions

List email suppressions

Returns the workspace's suppressed email addresses as a paginated list, newest first. Pass an address in the email parameter to narrow the page to that address.

The email filter matches by prefix rather than exactly, so bob@example.com also returns a suppressed bob@example.com.au. Compare the email on each record before treating the address you asked about as suppressed.

An address can appear more than once because Bird keeps one suppression record per reason. Delivery stays blocked while any blocking record for the address remains.

get/v1/email/suppressions

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/email/suppressions
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Query parameters

emailstring

Case-insensitive prefix filter on the address. Returns every suppression whose address starts with this value. A full address finds that address's records, while a fragment such as alice finds every address beginning with it. The same address can match several records, one per suppression reason.

reason'hard_bounce' | 'complaint' | 'unsubscribe' | 'manual'

Return only suppressions with this reason:

  • hard_bounce: Delivery permanently failed.
  • complaint: The recipient reported a message as spam.
  • unsubscribe: The recipient opted out. Deprecated: unsubscribes are now recorded as messaging preferences rather than suppressions, so no new records carry this reason. The filter returns legacy records until they are moved to messaging preferences.
  • manual: Added through the API or dashboard.
scope_type'workspace' | 'category' | 'audience' | 'topic' | 'contact' | 'domain'

Return only suppressions with this scope.

Every suppression is workspace-wide, so workspace returns all of them without narrowing the results. The other five values, category, audience, topic, contact and domain, always come back with an empty page.

limitinteger

Maximum number of items to return per page.

starting_afterstring

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_beforestring

Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

Paginated list of suppressions.

next_cursorstring nullable required

Cursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.

prev_cursorstring nullable required

Cursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.

refresh_cursorstring nullable required

Refresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.

Example response

{
  "data": [
    {
      "id": "sup_01krdgeqcxet5s7t44vh8rt9mg",
      "email": "user@example.com",
      "scope": {
        "id": "ws_01krdgeqcxet5s7t44vh8rt9mg"
      },
      "source_email_id": "em_01krdgeqcxet5s7t44vh8rt9mg",
      "source_recipient_id": "er_01krdgeqcxet5s7t44vh8rt9mg"
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.