跳到内容
Esc
↑↓导航↵打开⌘J预览

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必填
允许值:inbox
idstring<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必填
允许值:agenthuman
sharedboolean必填

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必填
试一试
服务器
授权
参数
请求
curl -X GET 'https://api.billionsend.com/inboxes/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
响应
{
  "object": "inbox",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "email_address": "string",
  "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",
  "receiving_address": "string",
  "from_name": "string",
  "unread": 0,
  "drafts": 0,
  "last_received": "string",
  "created_at": "string",
  "updated_at": "string",
  "kind": "agent",
  "shared": true,
  "expires_at": "string",
  "quarantined": 0,
  "pending_approval": 0
}

这个页面有帮助吗?