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}/emailsAuthorizationToken Bearer · headerobrigatórioA BillionSend API key (bs_…).
inbox_idstringobrigatórioThe inbox ID or its email address, such as support@example.com
thread_idstring<uuid>obrigatórioThe 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
objectstringobrigatóriolisthas_morebooleanobrigatóriodataInboxThreadEmail[]obrigatórioMostrar propriedadesOcultar propriedades
InboxThreadEmailidstring<uuid>obrigatóriofromstringobrigatóriotostring[]obrigatórioccstring[]obrigatóriobccstring[]obrigatórioreply_tostring[]obrigatóriosubjectstring | nullobrigatóriomessage_idstring | nullobrigatóriohtmlstring | nullobrigatóriotextstring | nullobrigatórioattachmentsobject[]obrigatórioMostrar propriedadesOcultar propriedades
objectidstringobrigatóriofilenamestring | nullobrigatóriosizeinteger | nullobrigatórioreadbooleanobrigatórioreceived_atstringobrigatóriodirectionstringobrigatórioinboundextracted_textstring | nullobrigatórioBillionSend extension: hidden text, quotes and signature removed
screeningobjectobrigatórioMostrar propriedadesOcultar propriedades
verdictstringobrigatóriopendingcleansuspiciousquarantinedreleasedsender_truststringobrigatórioownerallowlistedknown_threadexternalunauthenticatedfailedquarantine_reasonstring | nullobrigatóriofailed_authunauthenticated_sendernot_allowlistedinjectionphishingvirusunscreenedscreening_capnullreasonsstring[]obrigatórioinjection_scoreinteger | nullobrigatóriophishing_scoreinteger | nullobrigatóriohidden_text_removedbooleanobrigatóriospam_verdictstring | nullobrigatóriopassgrayfailnullvirus_verdictstring | nullobrigatóriopassfailprocessing_failednullidstring<uuid>obrigatóriofromstringobrigatóriotostring[]obrigatórioccstring[]obrigatóriobccstring[]obrigatórioreply_tostring[]obrigatóriosubjectstring | nullobrigatóriomessage_idstring | nullobrigatóriohtmlstring | nullobrigatóriotextstring | nullobrigatórioattachmentsobject[]obrigatórioMostrar propriedadesOcultar propriedades
objectidstringobrigatóriofilenamestring | nullobrigatóriosizeinteger | nullobrigatórioreadbooleanobrigatórioreceived_atstringobrigatóriodirectionstringobrigatóriooutboundstatusstringobrigatórioBillionSend extension: the email's last event
Missing, malformed, unknown or revoked API key
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatórioinclude_quarantined from an inbox-scoped key
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatórioInbox, thread or cursor not found
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatórioValidation error
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatórioOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório