Skip to content
Esc
↑↓navigate↵open⌘Jpreview

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.

GET/inboxes/{inbox_id}/threads/{thread_id}/emails
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Path parameters
inbox_idstringrequired

The inbox ID or its email address, such as support@example.com

thread_idstring<uuid>required

The thread ID

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.

include_quarantinedboolean

BillionSend extension: true includes held messages (owner views; a full access key that is not inbox-scoped)

Responses
200

Emails

objectstringrequired
Allowed:list
has_morebooleanrequired
dataInboxThreadEmail[]required
Show properties
Array of InboxThreadEmail
Any of:
object
idstring<uuid>required
fromstringrequired
tostring[]required
ccstring[]required
bccstring[]required
reply_tostring[]required
subjectstring | nullrequired
message_idstring | nullrequired
htmlstring | nullrequired
textstring | nullrequired
attachmentsobject[]required
Show properties
Array of object
idstringrequired
filenamestring | nullrequired
sizeinteger | nullrequired
readbooleanrequired
received_atstringrequired
directionstringrequired
Allowed:inbound
extracted_textstring | nullrequired

BillionSend extension: hidden text, quotes and signature removed

screeningobjectrequired
Show properties
verdictstringrequired
Allowed:pendingcleansuspiciousquarantinedreleased
sender_truststringrequired
Allowed:ownerallowlistedknown_threadexternalunauthenticatedfailed
quarantine_reasonstring | nullrequired
Allowed:failed_authunauthenticated_sendernot_allowlistedinjectionphishingvirusunscreenedscreening_capnull
reasonsstring[]required
injection_scoreinteger | nullrequired
phishing_scoreinteger | nullrequired
hidden_text_removedbooleanrequired
spam_verdictstring | nullrequired
Allowed:passgrayfailnull
virus_verdictstring | nullrequired
Allowed:passfailprocessing_failednull
object
idstring<uuid>required
fromstringrequired
tostring[]required
ccstring[]required
bccstring[]required
reply_tostring[]required
subjectstring | nullrequired
message_idstring | nullrequired
htmlstring | nullrequired
textstring | nullrequired
attachmentsobject[]required
Show properties
Array of object
idstringrequired
filenamestring | nullrequired
sizeinteger | nullrequired
readbooleanrequired
received_atstringrequired
directionstringrequired
Allowed:outbound
statusstringrequired

BillionSend extension: the email's last event

401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
403

include_quarantined from an inbox-scoped key

statusCodenumberrequired
namestringrequired
messagestringrequired
404

Inbox, thread or cursor not found

statusCodenumberrequired
namestringrequired
messagestringrequired
422

Validation error

statusCodenumberrequired
namestringrequired
messagestringrequired
429

Over 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/inboxes/string/threads/497f6eca-6276-4993-bfeb-53cbbbba6f08/emails' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "object": "list",
  "has_more": true,
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "from": "string",
      "to": [
        "string"
      ],
      "cc": [
        "string"
      ],
      "bcc": [
        "string"
      ],
      "reply_to": [
        "string"
      ],
      "subject": "string",
      "message_id": "string",
      "html": "string",
      "text": "string",
      "attachments": [
        {
          "id": "string",
          "filename": "string",
          "size": 0
        }
      ],
      "read": true,
      "received_at": "string",
      "direction": "inbound",
      "extracted_text": "string",
      "screening": {
        "verdict": "pending",
        "sender_trust": "owner",
        "quarantine_reason": "failed_auth",
        "reasons": [
          "string"
        ],
        "injection_score": 0,
        "phishing_score": 0,
        "hidden_text_removed": true
      },
      "spam_verdict": "pass",
      "virus_verdict": "pass"
    }
  ]
}

Was this page helpful?