Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Retrieve a suppression

GET/suppressions/{id}
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Path parameters
idstringrequired
min length 1
Responses
200

Suppression by id or by email address. 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. An erased row reports "[erased]" as its email.

idstring<uuid>required
emailstringrequired
originstringrequired
Allowed:bouncecomplaintmanual
source_idstring<uuid> | nullrequired

Email id whose bounce/complaint created the entry

created_atstringrequired
objectstringrequired
Allowed:suppression
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
404

Not found

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/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "email": "string",
  "origin": "bounce",
  "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
  "created_at": "string",
  "object": "suppression"
}

Was this page helpful?