Skip to content
Esc
↑↓navigate↵open⌘Jpreview

List quarantine

BillionSend extension: the inbox’s held messages, newest first, metadata only. Not for inbox-scoped keys.

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

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.

Responses
200

Held messages

objectstringrequired
Allowed:list
has_morebooleanrequired
dataobject[]required
Show properties
Array of object
idstring<uuid>required
thread_idstring<uuid> | nullrequired
fromstringrequired
subjectstring | nullrequired
received_atstringrequired
quarantine_reasonstringrequired
Allowed:failed_authunauthenticated_sendernot_allowlistedinjectionphishingvirusunscreenedscreening_cap
sender_truststringrequired
Allowed:ownerallowlistedknown_threadexternalunauthenticatedfailed
injection_scoreinteger | nullrequired
phishing_scoreinteger | nullrequired
virus_signaturestring | nullrequired
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
403

Restricted API key

statusCodenumberrequired
namestringrequired
messagestringrequired
404

Inbox 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/quarantine' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "object": "list",
  "has_more": true,
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
      "from": "string",
      "subject": "string",
      "received_at": "string",
      "quarantine_reason": "failed_auth",
      "sender_trust": "owner",
      "injection_score": 0,
      "phishing_score": 0,
      "virus_signature": "string"
    }
  ]
}

Was this page helpful?