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}/emailsAuthorizationJeton Bearer · headerrequisA BillionSend API key (bs_…).
inbox_idstringrequisThe inbox ID or its email address, such as support@example.com
thread_idstring<uuid>requisThe 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
objectstringrequislisthas_morebooleanrequisdataInboxThreadEmail[]requisAfficher les propriétésMasquer les propriétés
InboxThreadEmailidstring<uuid>requisfromstringrequistostring[]requisccstring[]requisbccstring[]requisreply_tostring[]requissubjectstring | nullrequismessage_idstring | nullrequishtmlstring | nullrequistextstring | nullrequisattachmentsobject[]requisAfficher les propriétésMasquer les propriétés
objectidstringrequisfilenamestring | nullrequissizeinteger | nullrequisreadbooleanrequisreceived_atstringrequisdirectionstringrequisinboundextracted_textstring | nullrequisBillionSend extension: hidden text, quotes and signature removed
screeningobjectrequisAfficher les propriétésMasquer les propriétés
verdictstringrequispendingcleansuspiciousquarantinedreleasedsender_truststringrequisownerallowlistedknown_threadexternalunauthenticatedfailedquarantine_reasonstring | nullrequisfailed_authunauthenticated_sendernot_allowlistedinjectionphishingvirusunscreenedscreening_capnullreasonsstring[]requisinjection_scoreinteger | nullrequisphishing_scoreinteger | nullrequishidden_text_removedbooleanrequisspam_verdictstring | nullrequispassgrayfailnullvirus_verdictstring | nullrequispassfailprocessing_failednullidstring<uuid>requisfromstringrequistostring[]requisccstring[]requisbccstring[]requisreply_tostring[]requissubjectstring | nullrequismessage_idstring | nullrequishtmlstring | nullrequistextstring | nullrequisattachmentsobject[]requisAfficher les propriétésMasquer les propriétés
objectidstringrequisfilenamestring | nullrequissizeinteger | nullrequisreadbooleanrequisreceived_atstringrequisdirectionstringrequisoutboundstatusstringrequisBillionSend extension: the email's last event
Missing, malformed, unknown or revoked API key
statusCodenumberrequisnamestringrequismessagestringrequisinclude_quarantined from an inbox-scoped key
statusCodenumberrequisnamestringrequismessagestringrequisInbox, thread or cursor not found
statusCodenumberrequisnamestringrequismessagestringrequisValidation error
statusCodenumberrequisnamestringrequismessagestringrequisOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequisnamestringrequismessagestringrequis