Aller au contenu
Esc
↑↓naviguer↵ouvrir⌘Japerçu

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
Autorisation
AuthorizationJeton Bearer · headerrequis

A BillionSend API key (bs_…).

Paramètres de chemin
inbox_idstringrequis

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

thread_idstring<uuid>requis

The thread ID

Paramètres de requête
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)

Réponses
200

Emails

objectstringrequis
Valeurs autorisées :list
has_morebooleanrequis
dataInboxThreadEmail[]requis
Afficher les propriétés
Tableau de InboxThreadEmail
Au moins un de :
object
idstring<uuid>requis
fromstringrequis
tostring[]requis
ccstring[]requis
bccstring[]requis
reply_tostring[]requis
subjectstring | nullrequis
message_idstring | nullrequis
htmlstring | nullrequis
textstring | nullrequis
attachmentsobject[]requis
Afficher les propriétés
Tableau de object
idstringrequis
filenamestring | nullrequis
sizeinteger | nullrequis
readbooleanrequis
received_atstringrequis
directionstringrequis
Valeurs autorisées :inbound
extracted_textstring | nullrequis

BillionSend extension: hidden text, quotes and signature removed

screeningobjectrequis
Afficher les propriétés
verdictstringrequis
Valeurs autorisées :pendingcleansuspiciousquarantinedreleased
sender_truststringrequis
Valeurs autorisées :ownerallowlistedknown_threadexternalunauthenticatedfailed
quarantine_reasonstring | nullrequis
Valeurs autorisées :failed_authunauthenticated_sendernot_allowlistedinjectionphishingvirusunscreenedscreening_capnull
reasonsstring[]requis
injection_scoreinteger | nullrequis
phishing_scoreinteger | nullrequis
hidden_text_removedbooleanrequis
spam_verdictstring | nullrequis
Valeurs autorisées :passgrayfailnull
virus_verdictstring | nullrequis
Valeurs autorisées :passfailprocessing_failednull
object
idstring<uuid>requis
fromstringrequis
tostring[]requis
ccstring[]requis
bccstring[]requis
reply_tostring[]requis
subjectstring | nullrequis
message_idstring | nullrequis
htmlstring | nullrequis
textstring | nullrequis
attachmentsobject[]requis
Afficher les propriétés
Tableau de object
idstringrequis
filenamestring | nullrequis
sizeinteger | nullrequis
readbooleanrequis
received_atstringrequis
directionstringrequis
Valeurs autorisées :outbound
statusstringrequis

BillionSend extension: the email's last event

401

Missing, malformed, unknown or revoked API key

statusCodenumberrequis
namestringrequis
messagestringrequis
403

include_quarantined from an inbox-scoped key

statusCodenumberrequis
namestringrequis
messagestringrequis
404

Inbox, thread or cursor not found

statusCodenumberrequis
namestringrequis
messagestringrequis
422

Validation error

statusCodenumberrequis
namestringrequis
messagestringrequis
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberrequis
namestringrequis
messagestringrequis
Essayer
Serveur
Autorisation
Paramètres
Requête
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'
Réponse
{
  "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"
    }
  ]
}

Cette page vous a-t-elle été utile ?