Get a received email
One received email with its html, text, headers, authentication results and a signed link to the original message, plus BillionSend’s screening, verdicts, the extracted read and, where allowed, its verification code or sign-in link. Needs a full access key. An inbox-scoped key or an MCP token gets 403 email_quarantined for held mail, and 404 while it is being screened. Everything in a received email was written by whoever sent it, so its HTML is safe to show only in a sandbox.
/emails/receiving/{id}AuthorizationToken Bearer · headerobligatorioA BillionSend API key (bs_…).
idstring<uuid>obligatoriohtml_formatstringdata_uri (default) inlines images the HTML references by cid: as data: URIs; cid leaves the cid: references, the parts being in attachments
data_uricidReceived email
idstring<uuid>obligatoriotostring[]obligatoriofromstringobligatorioBare address from the From header; the display name is in headers.from
created_atstringobligatoriosubjectstringobligatoriobccstring[]obligatorioccstring[]obligatorioreply_tostring[]obligatorioreceived_forstring[]obligatorioThe team's envelope recipients: the addresses the message was delivered to here
message_idstringobligatorioattachmentsobject[]obligatorioMostrar propiedadesOcultar propiedades
objectidstring<uuid>obligatoriofilenamestring | nullobligatoriocontent_typestringobligatoriocontent_idstring | nullobligatoriocontent_dispositionstring | nullobligatoriosizeintegerobligatorioinbox_idstring<uuid> | nullobligatorioBillionSend extension: the inbox this read is about (an inbox-scoped key's own, the inbox_id filter's, else the oldest inbox the email reached); null for mail no inbox took
thread_idstring<uuid> | nullobligatorioBillionSend extension: that inbox's thread
inboxesobject[]BillionSend extension, full access keys only: every inbox the email reached and its screening verdict there
Mostrar propiedadesOcultar propiedades
objectinbox_idstring<uuid>obligatoriothread_idstring<uuid>obligatorioverdictstringobligatoriopendingcleansuspiciousquarantinedreleasedspam_verdictstring | nullobligatorioBillionSend extension: the local spam score's verdict; null for mail from before it existed
passgrayfailnullvirus_verdictstring | nullobligatorioBillionSend extension: clamd's verdict (fail blocks every download for good); null when nothing scanned it
passfailprocessing_failednullreadbooleanBillionSend extension, with an inbox in context: whether that inbox marked it read
screeningobjectobligatorioBillionSend extension: the screening verdict, the sender's trust tier, why it was held, the inbound judge's reasons and scores (0-100), and whether hidden text was removed from what agents read
Mostrar propiedadesOcultar propiedades
verdictstringobligatoriopendingcleansuspiciousquarantinedreleasedsender_truststringobligatorioownerallowlistedknown_threadexternalunauthenticatedfailedquarantine_reasonstring | nullobligatoriofailed_authunauthenticated_sendernot_allowlistedinjectionphishingvirusunscreenedscreening_capnullreasonsstring[]obligatorioinjection_scoreinteger | nullobligatoriophishing_scoreinteger | nullobligatoriohidden_text_removedbooleanobligatoriospam_scoreinteger | nullobligatorioBillionSend extension: the local spam score, 0-100
virus_signaturestring | nullobligatorioBillionSend extension: clamd's signature name when it failed
extracted_textstring | nullobligatorioBillionSend extension: what a person sees of the reply, as text with light markdown: hidden text, invisible characters, quoted history and signature taken out. null once the content retention removed it
extractedobjectobligatorioBillionSend extension: the verification code or sign-in link, served only from delivered mail of a sender that did not fail authentication, in an inbox that extracts codes. Links are never fetched.
Mostrar propiedadesOcultar propiedades
kindsstring[]obligatoriocodestring | nullobligatoriolinkstring | nullobligatoriolink_domain_matches_senderboolean | nullobligatorioambiguousbooleanobligatorioobjectstringobligatorioemailhtmlstring | nullobligatoriohtml_formatstringobligatoriodata_uricidtextstring | nullobligatorioheadersobject | nullobligatorioTop-level headers, lowercase names; a repeated header's values joined by newlines
authenticationobjectobligatoriopass, fail, gray, processing_failed or unknown, checked when the message arrived
Mostrar propiedadesOcultar propiedades
spfstringobligatoriodkimstringobligatoriodmarcstringobligatoriorawobject | nullobligatorioThe original RFC 822 message: a signed link valid for one hour that needs no API key. null once the content retention period removed the message.
Mostrar propiedadesOcultar propiedades
download_urlstringobligatorioexpires_atstringobligatorioMissing, malformed, unknown or revoked API key
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorioRestricted API key, or the email is quarantined
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorioNot found
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorioValidation error
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorioOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio