List quarantine
BillionSend extension: the inbox’s held messages, newest first, metadata only. Not for inbox-scoped keys.
GET
/inboxes/{inbox_id}/quarantineAuthorization
AuthorizationBearer token · headerrequiredA BillionSend API key (bs_…).
Path parameters
inbox_idstringrequiredThe inbox ID or its email address, such as support@example.com
Query parameters
limitintegerPage 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
objectstringrequiredAllowed:
listhas_morebooleanrequireddataobject[]requiredShow propertiesHide properties
Array of
objectidstring<uuid>requiredthread_idstring<uuid> | nullrequiredfromstringrequiredsubjectstring | nullrequiredreceived_atstringrequiredquarantine_reasonstringrequiredAllowed:
failed_authunauthenticated_sendernot_allowlistedinjectionphishingvirusunscreenedscreening_capsender_truststringrequiredAllowed:
ownerallowlistedknown_threadexternalunauthenticatedfailedinjection_scoreinteger | nullrequiredphishing_scoreinteger | nullrequiredvirus_signaturestring | nullrequired401
Missing, malformed, unknown or revoked API key
statusCodenumberrequirednamestringrequiredmessagestringrequired403
Restricted API key
statusCodenumberrequirednamestringrequiredmessagestringrequired404
Inbox or cursor not found
statusCodenumberrequirednamestringrequiredmessagestringrequired422
Validation error
statusCodenumberrequirednamestringrequiredmessagestringrequired429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequirednamestringrequiredmessagestringrequired