跳到内容
Esc
↑↓导航↵打开⌘J预览

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
授权
AuthorizationBearer 令牌 · header必填

A BillionSend API key (bs_…).

查询参数
limitinteger

Page size, 1-100 (default 20)

最小值 1 · 最大值 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

允许值:bouncecomplaintmanual
响应
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.

objectstring必填
允许值:list
dataobject[]必填
显示属性
object 数组
idstring<uuid>必填
emailstring必填
originstring必填
允许值:bouncecomplaintmanual
source_idstring<uuid> | null必填

Email id whose bounce/complaint created the entry

created_atstring必填
has_moreboolean必填
401

Missing, malformed, unknown or revoked API key

statusCodenumber必填
namestring必填
messagestring必填
422

Validation error

statusCodenumber必填
namestring必填
messagestring必填
429

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

statusCodenumber必填
namestring必填
messagestring必填
试一试
服务器
授权
参数
请求
curl -X GET 'https://api.billionsend.com/suppressions' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
响应
{
  "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
}

这个页面有帮助吗?