Retrieve an inbox
By id, or by its email address (case-insensitive). An expired inbox is not found.
GET
/inboxes/{inbox_id}Autorisation
AuthorizationJeton Bearer · headerrequisA BillionSend API key (bs_…).
Paramètres de chemin
inbox_idstringrequisThe inbox ID or its email address, such as support@example.com
Réponses
200
Inbox
objectstringrequisValeurs autorisées :
inboxidstring<uuid>requisnamestringrequisemail_addressstringrequisdomain_idstring<uuid>requisA shared address's is its team's shared subdomain: the GET /domains row with shared: true
receiving_addressstring | nullrequisfrom_namestring | nullrequisunreadintegerrequisThreads with an unread message
draftsintegerrequisUnsent drafts
last_receivedstring | nullrequiscreated_atstringrequisupdated_atstringrequiskindstringrequisValeurs autorisées :
agenthumansharedbooleanrequisOn the shared inbox domain
expires_atstring | nullrequisquarantinedintegerrequisHeld messages not yet released
pending_approvalintegerrequisDrafts waiting for a person
401
Missing, malformed, unknown or revoked API key
statusCodenumberrequisnamestringrequismessagestringrequis404
Not found
statusCodenumberrequisnamestringrequismessagestringrequis422
Validation error
statusCodenumberrequisnamestringrequismessagestringrequis429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequisnamestringrequismessagestringrequis