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.
/inboxes/{inbox_id}/threadsAuthorizationBearer token · headerrequiredA BillionSend API key (bs_…).
inbox_idstringrequiredThe inbox ID or its email address, such as support@example.com
limitintegerPage size, 1-100 (default 20)
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.
foldersstringComma-separated: inbox, archive, spam, sent, trash. Defaults to inbox, or inbox,archive,sent with labels
labelsstringComma-separated label ids (at most 50); threads with any of them
readbooleantrue: every message read; false: at least one unread
include_quarantinedbooleanBillionSend extension: true includes held messages (owner views; a full access key that is not inbox-scoped)
Threads
objectstringrequiredlisthas_morebooleanrequireddataobject[]requiredShow propertiesHide properties
objectidstring<uuid>requiredsubjectstring | nullrequiredfromstring | nullrequiredtostring[]requiredccstring[]requiredbccstring[]requiredlabelsobject[]requiredShow propertiesHide properties
objectidstring<uuid>requirednamestringrequiredcolorstringrequiredemail_countintegerrequiredhas_attachmentbooleanrequiredhas_draftbooleanrequiredreadbooleanrequiredquarantinedintegerBillionSend 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_atstringrequiredfolderstringrequiredinboxarchivespamsenttrashMissing, malformed, unknown or revoked API key
statusCodenumberrequirednamestringrequiredmessagestringrequiredinclude_quarantined from an inbox-scoped key
statusCodenumberrequirednamestringrequiredmessagestringrequiredInbox, label or cursor not found
statusCodenumberrequirednamestringrequiredmessagestringrequiredValidation error
statusCodenumberrequirednamestringrequiredmessagestringrequiredOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequirednamestringrequiredmessagestringrequired