Retrieve an inbox
By id, or by its email address (case-insensitive). An expired inbox is not found.
GET
/inboxes/{inbox_id}Autorização
AuthorizationToken Bearer · headerobrigatórioA BillionSend API key (bs_…).
Parâmetros de caminho
inbox_idstringobrigatórioThe inbox ID or its email address, such as support@example.com
Respostas
200
Inbox
objectstringobrigatórioValores permitidos:
inboxidstring<uuid>obrigatórionamestringobrigatórioemail_addressstringobrigatóriodomain_idstring<uuid>obrigatórioA shared address's is its team's shared subdomain: the GET /domains row with shared: true
receiving_addressstring | nullobrigatóriofrom_namestring | nullobrigatóriounreadintegerobrigatórioThreads with an unread message
draftsintegerobrigatórioUnsent drafts
last_receivedstring | nullobrigatóriocreated_atstringobrigatórioupdated_atstringobrigatóriokindstringobrigatórioValores permitidos:
agenthumansharedbooleanobrigatórioOn the shared inbox domain
expires_atstring | nullobrigatórioquarantinedintegerobrigatórioHeld messages not yet released
pending_approvalintegerobrigatórioDrafts waiting for a person
401
Missing, malformed, unknown or revoked API key
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório404
Not found
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório422
Validation error
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório