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}AuthorizationBearer token · headerrequiredA BillionSend API key (bs_…).
idstring<uuid>requiredhtml_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>requiredtostring[]requiredfromstringrequiredBare address from the From header; the display name is in headers.from
created_atstringrequiredsubjectstringrequiredbccstring[]requiredccstring[]requiredreply_tostring[]requiredreceived_forstring[]requiredThe team's envelope recipients: the addresses the message was delivered to here
message_idstringrequiredattachmentsobject[]requiredShow propertiesHide properties
objectidstring<uuid>requiredfilenamestring | nullrequiredcontent_typestringrequiredcontent_idstring | nullrequiredcontent_dispositionstring | nullrequiredsizeintegerrequiredinbox_idstring<uuid> | nullrequiredBillionSend 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> | nullrequiredBillionSend extension: that inbox's thread
inboxesobject[]BillionSend extension, full access keys only: every inbox the email reached and its screening verdict there
Show propertiesHide properties
objectinbox_idstring<uuid>requiredthread_idstring<uuid>requiredverdictstringrequiredpendingcleansuspiciousquarantinedreleasedspam_verdictstring | nullrequiredBillionSend extension: the local spam score's verdict; null for mail from before it existed
passgrayfailnullvirus_verdictstring | nullrequiredBillionSend 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
screeningobjectrequiredBillionSend 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
Show propertiesHide properties
verdictstringrequiredpendingcleansuspiciousquarantinedreleasedsender_truststringrequiredownerallowlistedknown_threadexternalunauthenticatedfailedquarantine_reasonstring | nullrequiredfailed_authunauthenticated_sendernot_allowlistedinjectionphishingvirusunscreenedscreening_capnullreasonsstring[]requiredinjection_scoreinteger | nullrequiredphishing_scoreinteger | nullrequiredhidden_text_removedbooleanrequiredspam_scoreinteger | nullrequiredBillionSend extension: the local spam score, 0-100
virus_signaturestring | nullrequiredBillionSend extension: clamd's signature name when it failed
extracted_textstring | nullrequiredBillionSend 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
extractedobjectrequiredBillionSend 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.
Show propertiesHide properties
kindsstring[]requiredcodestring | nullrequiredlinkstring | nullrequiredlink_domain_matches_senderboolean | nullrequiredambiguousbooleanrequiredobjectstringrequiredemailhtmlstring | nullrequiredhtml_formatstringrequireddata_uricidtextstring | nullrequiredheadersobject | nullrequiredTop-level headers, lowercase names; a repeated header's values joined by newlines
authenticationobjectrequiredpass, fail, gray, processing_failed or unknown, checked when the message arrived
Show propertiesHide properties
spfstringrequireddkimstringrequireddmarcstringrequiredrawobject | nullrequiredThe 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.
Show propertiesHide properties
download_urlstringrequiredexpires_atstringrequiredMissing, malformed, unknown or revoked API key
statusCodenumberrequirednamestringrequiredmessagestringrequiredRestricted API key, or the email is quarantined
statusCodenumberrequirednamestringrequiredmessagestringrequiredNot found
statusCodenumberrequirednamestringrequiredmessagestringrequiredValidation error
statusCodenumberrequirednamestringrequiredmessagestringrequiredOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequirednamestringrequiredmessagestringrequired