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 · headerobligatorioA BillionSend API key (bs_…).
inbox_idstringobligatorioThe inbox ID or its email address, such as support@example.com
thread_idstring<uuid>obligatorioThe 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
objectstringobligatoriolisthas_morebooleanobligatoriodataInboxThreadEmail[]obligatorioMostrar propiedadesOcultar propiedades
InboxThreadEmailidstring<uuid>obligatoriofromstringobligatoriotostring[]obligatorioccstring[]obligatoriobccstring[]obligatorioreply_tostring[]obligatoriosubjectstring | nullobligatoriomessage_idstring | nullobligatoriohtmlstring | nullobligatoriotextstring | nullobligatorioattachmentsobject[]obligatorioMostrar propiedadesOcultar propiedades
objectidstringobligatoriofilenamestring | nullobligatoriosizeinteger | nullobligatorioreadbooleanobligatorioreceived_atstringobligatoriodirectionstringobligatorioinboundextracted_textstring | nullobligatorioBillionSend extension: hidden text, quotes and signature removed
screeningobjectobligatorioMostrar propiedadesOcultar propiedades
verdictstringobligatoriopendingcleansuspiciousquarantinedreleasedsender_truststringobligatorioownerallowlistedknown_threadexternalunauthenticatedfailedquarantine_reasonstring | nullobligatoriofailed_authunauthenticated_sendernot_allowlistedinjectionphishingvirusunscreenedscreening_capnullreasonsstring[]obligatorioinjection_scoreinteger | nullobligatoriophishing_scoreinteger | nullobligatoriohidden_text_removedbooleanobligatoriospam_verdictstring | nullobligatoriopassgrayfailnullvirus_verdictstring | nullobligatoriopassfailprocessing_failednullidstring<uuid>obligatoriofromstringobligatoriotostring[]obligatorioccstring[]obligatoriobccstring[]obligatorioreply_tostring[]obligatoriosubjectstring | nullobligatoriomessage_idstring | nullobligatoriohtmlstring | nullobligatoriotextstring | nullobligatorioattachmentsobject[]obligatorioMostrar propiedadesOcultar propiedades
objectidstringobligatoriofilenamestring | nullobligatoriosizeinteger | nullobligatorioreadbooleanobligatorioreceived_atstringobligatoriodirectionstringobligatoriooutboundstatusstringobligatorioBillionSend extension: the email's last event
Missing, malformed, unknown or revoked API key
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorioinclude_quarantined from an inbox-scoped key
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorioInbox, thread or cursor not found
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorioValidation error
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorioOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio