Retrieve an inbox
By id, or by its email address (case-insensitive). An expired inbox is not found.
GET
/inboxes/{inbox_id}授权
AuthorizationBearer 令牌 · header必填A BillionSend API key (bs_…).
路径参数
inbox_idstring必填The inbox ID or its email address, such as support@example.com
响应
200
Inbox
objectstring必填允许值:
inboxidstring<uuid>必填namestring必填email_addressstring必填domain_idstring<uuid>必填A shared address's is its team's shared subdomain: the GET /domains row with shared: true
receiving_addressstring | null必填from_namestring | null必填unreadinteger必填Threads with an unread message
draftsinteger必填Unsent drafts
last_receivedstring | null必填created_atstring必填updated_atstring必填kindstring必填允许值:
agenthumansharedboolean必填On the shared inbox domain
expires_atstring | null必填quarantinedinteger必填Held messages not yet released
pending_approvalinteger必填Drafts waiting for a person
401
Missing, malformed, unknown or revoked API key
statusCodenumber必填namestring必填messagestring必填404
Not found
statusCodenumber必填namestring必填messagestring必填422
Validation error
statusCodenumber必填namestring必填messagestring必填429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumber必填namestring必填messagestring必填