Retrieve an inbox
By id, or by its email address (case-insensitive). An expired inbox is not found.
GET
/inboxes/{inbox_id}Autorización
AuthorizationToken Bearer · headerobligatorioA BillionSend API key (bs_…).
Parámetros de ruta
inbox_idstringobligatorioThe inbox ID or its email address, such as support@example.com
Respuestas
200
Inbox
objectstringobligatorioValores permitidos:
inboxidstring<uuid>obligatorionamestringobligatorioemail_addressstringobligatoriodomain_idstring<uuid>obligatorioA shared address's is its team's shared subdomain: the GET /domains row with shared: true
receiving_addressstring | nullobligatoriofrom_namestring | nullobligatoriounreadintegerobligatorioThreads with an unread message
draftsintegerobligatorioUnsent drafts
last_receivedstring | nullobligatoriocreated_atstringobligatorioupdated_atstringobligatoriokindstringobligatorioValores permitidos:
agenthumansharedbooleanobligatorioOn the shared inbox domain
expires_atstring | nullobligatorioquarantinedintegerobligatorioHeld messages not yet released
pending_approvalintegerobligatorioDrafts waiting for a person
401
Missing, malformed, unknown or revoked API key
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio404
Not found
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio422
Validation error
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio