Skip to content
Esc
↑↓navigate↵open⌘Jpreview

List suppressions

Newest first, with cursor pagination: after takes the last id of a page and pages toward older items, before takes the first id and pages back toward newer ones.

GET/suppressions
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Query parameters
limitinteger

Page size, 1-100 (default 20)

min 1 · max 100
afterstring<uuid>

Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.

beforestring<uuid>

Cursor: id of the first item of the current page; returns the previous page; same rule as after.

originstring

Only suppressions of this origin: bounce, complaint or manual

Allowed:bouncecomplaintmanual
Responses
200

Suppressions, optionally filtered by origin (bounce, complaint or manual). Rows whose address was erased (GDPR/LGPD) keep blocking sends but are hidden from the list and from lookups by email; they are reachable by id only.

objectstringrequired
Allowed:list
dataobject[]required
Show properties
Array of object
idstring<uuid>required
emailstringrequired
originstringrequired
Allowed:bouncecomplaintmanual
source_idstring<uuid> | nullrequired

Email id whose bounce/complaint created the entry

created_atstringrequired
has_morebooleanrequired
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
422

Validation error

statusCodenumberrequired
namestringrequired
messagestringrequired
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberrequired
namestringrequired
messagestringrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.billionsend.com/suppressions' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "object": "list",
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "email": "string",
      "origin": "bounce",
      "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
      "created_at": "string"
    }
  ],
  "has_more": true
}

Was this page helpful?