Aller au contenu
Esc
↑↓naviguer↵ouvrir⌘Japerçu

Retrieve an inbox

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

GET/inboxes/{inbox_id}
Autorisation
AuthorizationJeton Bearer · headerrequis

A BillionSend API key (bs_…).

Paramètres de chemin
inbox_idstringrequis

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

Réponses
200

Inbox

objectstringrequis
Valeurs autorisées :inbox
idstring<uuid>requis
namestringrequis
email_addressstringrequis
domain_idstring<uuid>requis

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

receiving_addressstring | nullrequis
from_namestring | nullrequis
unreadintegerrequis

Threads with an unread message

draftsintegerrequis

Unsent drafts

last_receivedstring | nullrequis
created_atstringrequis
updated_atstringrequis
kindstringrequis
Valeurs autorisées :agenthuman
sharedbooleanrequis

On the shared inbox domain

expires_atstring | nullrequis
quarantinedintegerrequis

Held messages not yet released

pending_approvalintegerrequis

Drafts waiting for a person

401

Missing, malformed, unknown or revoked API key

statusCodenumberrequis
namestringrequis
messagestringrequis
404

Not found

statusCodenumberrequis
namestringrequis
messagestringrequis
422

Validation error

statusCodenumberrequis
namestringrequis
messagestringrequis
429

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

statusCodenumberrequis
namestringrequis
messagestringrequis
Essayer
Serveur
Autorisation
Paramètres
Requête
curl -X GET 'https://api.billionsend.com/inboxes/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Réponse
{
  "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
}

Cette page vous a-t-elle été utile ?