Skip to content
Esc
↑↓navigate↵open⌘Jpreview

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
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Path parameters
inbox_idstringrequired

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

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.

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)

Responses
200

Threads

objectstringrequired
Allowed:list
has_morebooleanrequired
dataobject[]required
Show properties
Array of object
idstring<uuid>required
subjectstring | nullrequired
fromstring | nullrequired
tostring[]required
ccstring[]required
bccstring[]required
labelsobject[]required
Show properties
Array of object
idstring<uuid>required
namestringrequired
colorstringrequired
email_countintegerrequired
has_attachmentbooleanrequired
has_draftbooleanrequired
readbooleanrequired
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_atstringrequired
folderstringrequired
Allowed:inboxarchivespamsenttrash
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
403

include_quarantined from an inbox-scoped key

statusCodenumberrequired
namestringrequired
messagestringrequired
404

Inbox, label or cursor not found

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/inboxes/string/threads' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "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"
    }
  ]
}

Was this page helpful?