Zum Inhalt springen
Esc
↑↓navigieren↵öffnen⌘Jvorschau

Search threads

Threads whose emails match, most recently active first. Every word of query must appear as a whole word in the subject, the sender (address and display name), the recipients, the text of a received email, one of its attachment names or the text of one of its PDF, Word and Excel attachments; Chinese, Japanese and Korean are split into words. matched_email_id is the thread’s best match. An email becomes searchable a second or two after it arrives. 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/search
Autorisierung
AuthorizationBearer-Token · headererforderlich

A BillionSend API key (bs_…).

Pfadparameter
inbox_idstringerforderlich

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

Query-Parameter
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.

foldersstring

Comma-separated: inbox, archive, spam, sent, trash. Defaults to inbox, or inbox,archive,sent with labels

labelsstring

Comma-separated label ids (at most 50); threads with any of them

readboolean

true: every message read; false: at least one unread

include_quarantinedboolean

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

querystring

Words that must each appear as a whole word in the subject, sender, recipients, text of a received email, its attachment names or its PDF, Word and Excel attachments; "a phrase"; -word excludes. At most 256 characters and 32 words.

fromstring

Comma-separated words of the sender's address or name (at most 20)

tostring

Comma-separated words of a recipient (at most 20)

ccstring

Comma-separated words of a CC recipient (at most 20)

bccstring

Comma-separated words of a BCC recipient (at most 20)

has_attachmentboolean

true: only threads with an attachment; false: only without

start_datestring

A date (2026-09-01) or an ISO 8601 timestamp, UTC unless offset

end_datestring

Same forms; a date covers the whole day

Antworten
200

Matching threads

objectstringerforderlich
Erlaubt:list
has_morebooleanerforderlich
dataobject[]erforderlich
Eigenschaften anzeigen
Array von object
idstring<uuid>erforderlich
subjectstring | nullerforderlich
fromstring | nullerforderlich
tostring[]erforderlich
ccstring[]erforderlich
bccstring[]erforderlich
labelsobject[]erforderlich
Eigenschaften anzeigen
Array von object
idstring<uuid>erforderlich
namestringerforderlich
colorstringerforderlich
email_countintegererforderlich
has_attachmentbooleanerforderlich
has_draftbooleanerforderlich
readbooleanerforderlich
quarantinedinteger

BillionSend extension, with include_quarantined=true: messages in quarantine, not yet released; mail still being screened isn't counted. Held mail never counts as unread

received_atstringerforderlich
folderstringerforderlich
Erlaubt:inboxarchivespamsenttrash
matched_email_idstring<uuid> | nullerforderlich

The thread's best-matching email

highlightsobjecterforderlich

Fragments with match markers; only keys that matched; {} without query, or when only the text or an attachment name matched

Eigenschaften anzeigen
subjectstring[]
fromstring[]
tostring[]
ccstring[]
bccstring[]
401

Missing, malformed, unknown or revoked API key

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
403

include_quarantined from an inbox-scoped key

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
404

Inbox, label or cursor not found

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
422

Validation error

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
429

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

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
503

search_unavailable: search is briefly unavailable; retry after the Retry-After seconds

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
Ausprobieren
Server
Autorisierung
Parameter
Anfrage
curl -X GET 'https://api.billionsend.com/inboxes/string/threads/search' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Antwort
{
  "object": "list",
  "has_more": true,
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "subject": "string",
      "from": "string",
      "to": [
        "string"
      ],
      "cc": [
        "string"
      ],
      "bcc": [
        "string"
      ],
      "labels": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string",
          "color": "string"
        }
      ],
      "email_count": 0,
      "has_attachment": true,
      "has_draft": true,
      "read": true,
      "quarantined": 0,
      "received_at": "string",
      "folder": "inbox",
      "matched_email_id": "45440bc9-4e23-466c-bcfd-fe2429615e44",
      "highlights": {
        "subject": [
          "string"
        ],
        "from": [
          "string"
        ],
        "to": [
          "string"
        ],
        "cc": [
          "string"
        ],
        "bcc": [
          "string"
        ]
      }
    }
  ]
}

War diese Seite hilfreich?