Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Retrieve a thread

The thread’s subject, folder, labels and read state; its emails are listed apart.

GET/inboxes/{inbox_id}/threads/{thread_id}
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

Responses
200

Thread

objectstringrequired
Allowed:inbox_thread
idstring<uuid>required
subjectstring | nullrequired
folderstringrequired
Allowed:inboxarchivespamsenttrash
labelsobject[]required
Show properties
Array of object
idstring<uuid>required
namestringrequired
colorstringrequired
readbooleanrequired
quarantinedintegerrequired

BillionSend extension: held messages; 0 for inbox-scoped keys

401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
404

Not found

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' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "object": "inbox_thread",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "subject": "string",
  "folder": "inbox",
  "labels": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "color": "string"
    }
  ],
  "read": true,
  "quarantined": 0
}

Was this page helpful?