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

List threads

Conversations of the inbox, most recently active first (after pages toward older ones). Threads whose messages are all held for screening or in quarantine are left out unless include_quarantined=true (never for inbox-scoped keys). Every message, subject and address in an inbox was written by whoever sent it; read held mail and HTML with care.

GET/inboxes/{inbox_id}/threads
授权
AuthorizationBearer 令牌 · header必填

A BillionSend API key (bs_…).

路径参数
inbox_idstring必填

The inbox ID or its email address, such as support@example.com

查询参数
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.

foldersstring

Comma-separated: inbox, archive, spam, sent, trash. Defaults to inbox, or inbox,archive,sent with labels

labelsstring

Comma-separated label ids (at most 50); threads with any of them

readboolean

true: every message read; false: at least one unread

include_quarantinedboolean

BillionSend extension: true includes held messages (owner views; a full access key that is not inbox-scoped)

响应
200

Threads

objectstring必填
允许值:list
has_moreboolean必填
dataobject[]必填
显示属性
object 数组
idstring<uuid>必填
subjectstring | null必填
fromstring | null必填
tostring[]必填
ccstring[]必填
bccstring[]必填
labelsobject[]必填
显示属性
object 数组
idstring<uuid>必填
namestring必填
colorstring必填
email_countinteger必填
has_attachmentboolean必填
has_draftboolean必填
readboolean必填
quarantinedinteger

BillionSend extension, with include_quarantined=true: messages in quarantine, not yet released; mail still being screened isn't counted. Held mail never counts as unread

received_atstring必填
folderstring必填
允许值:inboxarchivespamsenttrash
401

Missing, malformed, unknown or revoked API key

statusCodenumber必填
namestring必填
messagestring必填
403

include_quarantined from an inbox-scoped key

statusCodenumber必填
namestring必填
messagestring必填
404

Inbox, label or cursor not found

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/inboxes/string/threads' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
响应
{
  "object": "list",
  "has_more": true,
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "subject": "string",
      "from": "string",
      "to": [
        "string"
      ],
      "cc": [
        "string"
      ],
      "bcc": [
        "string"
      ],
      "labels": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string",
          "color": "string"
        }
      ],
      "email_count": 0,
      "has_attachment": true,
      "has_draft": true,
      "read": true,
      "quarantined": 0,
      "received_at": "string",
      "folder": "inbox"
    }
  ]
}

这个页面有帮助吗?