List a thread's emails
Received and sent messages of the thread, oldest first (after pages toward newer ones), with their bodies. Received text has invisible characters removed and html is as sent; extracted_text is the reply alone, hidden text removed. Held messages 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}/threads/{thread_id}/emailsAuthorizationBearer-Token · headererforderlichA BillionSend API key (bs_…).
inbox_idstringerforderlichThe inbox ID or its email address, such as support@example.com
thread_idstring<uuid>erforderlichThe thread ID
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.
include_quarantinedbooleanBillionSend extension: true includes held messages (owner views; a full access key that is not inbox-scoped)
Emails
objectstringerforderlichlisthas_morebooleanerforderlichdataInboxThreadEmail[]erforderlichEigenschaften anzeigenEigenschaften ausblenden
InboxThreadEmailidstring<uuid>erforderlichfromstringerforderlichtostring[]erforderlichccstring[]erforderlichbccstring[]erforderlichreply_tostring[]erforderlichsubjectstring | nullerforderlichmessage_idstring | nullerforderlichhtmlstring | nullerforderlichtextstring | nullerforderlichattachmentsobject[]erforderlichEigenschaften anzeigenEigenschaften ausblenden
objectidstringerforderlichfilenamestring | nullerforderlichsizeinteger | nullerforderlichreadbooleanerforderlichreceived_atstringerforderlichdirectionstringerforderlichinboundextracted_textstring | nullerforderlichBillionSend extension: hidden text, quotes and signature removed
screeningobjecterforderlichEigenschaften anzeigenEigenschaften ausblenden
verdictstringerforderlichpendingcleansuspiciousquarantinedreleasedsender_truststringerforderlichownerallowlistedknown_threadexternalunauthenticatedfailedquarantine_reasonstring | nullerforderlichfailed_authunauthenticated_sendernot_allowlistedinjectionphishingvirusunscreenedscreening_capnullreasonsstring[]erforderlichinjection_scoreinteger | nullerforderlichphishing_scoreinteger | nullerforderlichhidden_text_removedbooleanerforderlichspam_verdictstring | nullerforderlichpassgrayfailnullvirus_verdictstring | nullerforderlichpassfailprocessing_failednullidstring<uuid>erforderlichfromstringerforderlichtostring[]erforderlichccstring[]erforderlichbccstring[]erforderlichreply_tostring[]erforderlichsubjectstring | nullerforderlichmessage_idstring | nullerforderlichhtmlstring | nullerforderlichtextstring | nullerforderlichattachmentsobject[]erforderlichEigenschaften anzeigenEigenschaften ausblenden
objectidstringerforderlichfilenamestring | nullerforderlichsizeinteger | nullerforderlichreadbooleanerforderlichreceived_atstringerforderlichdirectionstringerforderlichoutboundstatusstringerforderlichBillionSend extension: the email's last event
Missing, malformed, unknown or revoked API key
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlichinclude_quarantined from an inbox-scoped key
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlichInbox, thread or cursor not found
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlichValidation error
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlichOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich