Retrieve an inbox
By id, or by its email address (case-insensitive). An expired inbox is not found.
GET
/inboxes/{inbox_id}Authorization
AuthorizationBearer token · headerrequiredA BillionSend API key (bs_…).
Path parameters
inbox_idstringrequiredThe inbox ID or its email address, such as support@example.com
Responses
200
Inbox
objectstringrequiredAllowed:
inboxidstring<uuid>requirednamestringrequiredemail_addressstringrequireddomain_idstring<uuid>requiredA shared address's is its team's shared subdomain: the GET /domains row with shared: true
receiving_addressstring | nullrequiredfrom_namestring | nullrequiredunreadintegerrequiredThreads with an unread message
draftsintegerrequiredUnsent drafts
last_receivedstring | nullrequiredcreated_atstringrequiredupdated_atstringrequiredkindstringrequiredAllowed:
agenthumansharedbooleanrequiredOn the shared inbox domain
expires_atstring | nullrequiredquarantinedintegerrequiredHeld messages not yet released
pending_approvalintegerrequiredDrafts waiting for a person
401
Missing, malformed, unknown or revoked API key
statusCodenumberrequirednamestringrequiredmessagestringrequired404
Not found
statusCodenumberrequirednamestringrequiredmessagestringrequired422
Validation error
statusCodenumberrequirednamestringrequiredmessagestringrequired429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequirednamestringrequiredmessagestringrequired