Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Retrieve an inbox

By id, or by its email address (case-insensitive). An expired inbox is not found.

GET/inboxes/{inbox_id}
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Path parameters
inbox_idstringrequired

The inbox ID or its email address, such as support@example.com

Responses
200

Inbox

objectstringrequired
Allowed:inbox
idstring<uuid>required
namestringrequired
email_addressstringrequired
domain_idstring<uuid>required

A shared address's is its team's shared subdomain: the GET /domains row with shared: true

receiving_addressstring | nullrequired
from_namestring | nullrequired
unreadintegerrequired

Threads with an unread message

draftsintegerrequired

Unsent drafts

last_receivedstring | nullrequired
created_atstringrequired
updated_atstringrequired
kindstringrequired
Allowed:agenthuman
sharedbooleanrequired

On the shared inbox domain

expires_atstring | nullrequired
quarantinedintegerrequired

Held messages not yet released

pending_approvalintegerrequired

Drafts waiting for a person

401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
404

Not found

statusCodenumberrequired
namestringrequired
messagestringrequired
422

Validation error

statusCodenumberrequired
namestringrequired
messagestringrequired
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberrequired
namestringrequired
messagestringrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.billionsend.com/inboxes/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "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
}

Was this page helpful?