Skip to content
Esc
↑↓navigate↵open⌘Jpreview

List received emails

Mail received at the team’s receiving domains and inboxes, newest first (after pages toward older mail), with cursor pagination. Needs a full access key; a domain-scoped key lists mail addressed to its domain only, an inbox-scoped key mail delivered into its inbox. Mail held for screening or in quarantine is left out unless a full access key asks for it (include_quarantined, quarantined). With wait, the request is held until matching mail arrives (long-poll). An inbox_id the key can’t reach answers 404 at once, without waiting; an inbox-scoped key naming another inbox gets 403 restricted_api_key. Everything in a received email was written by whoever sent it, so its HTML is safe to show only in a sandbox.

GET/emails/receiving
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Query parameters
limitinteger

Page size, 1-100 (default 20)

min 1 · max 100
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.

waitinteger

BillionSend extension: hold the request up to this many seconds (0-50) until matching mail newer than the cursor arrives; an empty list with 200 when none did

sincestring<date-time>

BillionSend extension: only mail received after this instant; with wait and no cursor it defaults to one minute before the request

inbox_idstring<uuid>

BillionSend extension: only mail delivered into this inbox

tostring

BillionSend extension: only mail with this address in received_for

max length 320
fromstring

BillionSend extension: a sender address, or a domain matching itself and its subdomains

max length 320
subject_containsstring

BillionSend extension: case-insensitive subject substring

max length 200
unreadstring

BillionSend extension, with an inbox in context (inbox_id, or an inbox-scoped key): read state in that inbox

Allowed:truefalse
include_quarantinedstring

BillionSend extension, full access keys only: list held mail too, flagged by screening

Allowed:truefalse
quarantinedstring

BillionSend extension, full access keys only: list held mail only

Allowed:truefalse
Responses
200

Received emails

objectstringrequired
Allowed:list
has_morebooleanrequired
dataobject[]required
Show properties
Array of object
idstring<uuid>required
tostring[]required
fromstringrequired

Bare address from the From header; the display name is in headers.from

created_atstringrequired
subjectstringrequired
bccstring[]required
ccstring[]required
reply_tostring[]required
received_forstring[]required

The team's envelope recipients: the addresses the message was delivered to here

message_idstringrequired
attachmentsobject[]required
Show properties
Array of object
idstring<uuid>required
filenamestring | nullrequired
content_typestringrequired
content_idstring | nullrequired
content_dispositionstring | nullrequired
sizeintegerrequired
inbox_idstring<uuid> | nullrequired

BillionSend 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> | nullrequired

BillionSend extension: that inbox's thread

inboxesobject[]

BillionSend extension, full access keys only: every inbox the email reached and its screening verdict there

Show properties
Array of object
inbox_idstring<uuid>required
thread_idstring<uuid>required
verdictstringrequired
Allowed:pendingcleansuspiciousquarantinedreleased
spam_verdictstring | nullrequired

BillionSend extension: the local spam score's verdict; null for mail from before it existed

Allowed:passgrayfailnull
virus_verdictstring | nullrequired

BillionSend extension: clamd's verdict (fail blocks every download for good); null when nothing scanned it

Allowed:passfailprocessing_failednull
readboolean

BillionSend extension, with an inbox in context: whether that inbox marked it read

screeningobjectrequired

BillionSend extension: the screening verdict and the sender's trust tier

Show properties
verdictstringrequired
Allowed:pendingcleansuspiciousquarantinedreleased
sender_truststringrequired
Allowed:ownerallowlistedknown_threadexternalunauthenticatedfailed
extractedobjectrequired

BillionSend extension: whether a verification code or sign-in link was found; the values come with GET of one email

Show properties
kindsstring[]required
heldobject[]

BillionSend extension, with wait only: matching mail that arrived but is held (being screened or quarantined), ids and why only

Show properties
Array of object
idstring<uuid>required
inbox_idstring<uuid> | nullrequired
reasonstringrequired
Allowed:pendingquarantined
quarantine_reasonstring | nullrequired
Allowed:failed_authunauthenticated_sendernot_allowlistedinjectionphishingvirusunscreenedscreening_capnull
created_atstringrequired
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
403

Restricted API key

statusCodenumberrequired
namestringrequired
messagestringrequired
404

Inbox not found

statusCodenumberrequired
namestringrequired
messagestringrequired
422

Validation error

statusCodenumberrequired
namestringrequired
messagestringrequired
429

Too many concurrent waits, or the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberrequired
namestringrequired
messagestringrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.billionsend.com/emails/receiving' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "object": "list",
  "has_more": true,
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "to": [
        "string"
      ],
      "from": "string",
      "created_at": "string",
      "subject": "string",
      "bcc": [
        "string"
      ],
      "cc": [
        "string"
      ],
      "reply_to": [
        "string"
      ],
      "received_for": [
        "string"
      ],
      "message_id": "string",
      "attachments": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "filename": "string",
          "content_type": "string",
          "content_id": "string",
          "content_disposition": "string",
          "size": 0
        }
      ],
      "inbox_id": "5127f22b-d152-46dd-aeaa-3a852d9fbfc2",
      "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
      "inboxes": [
        {
          "inbox_id": "5127f22b-d152-46dd-aeaa-3a852d9fbfc2",
          "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
          "verdict": "pending"
        }
      ],
      "spam_verdict": "pass",
      "virus_verdict": "pass",
      "read": true,
      "screening": {
        "verdict": "pending",
        "sender_trust": "owner"
      },
      "extracted": {
        "kinds": [
          "code"
        ]
      }
    }
  ],
  "held": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "inbox_id": "5127f22b-d152-46dd-aeaa-3a852d9fbfc2",
      "reason": "pending",
      "quarantine_reason": "failed_auth",
      "created_at": "string"
    }
  ]
}

Was this page helpful?