Saltar al contenido
Esc
↑↓navegar↵abrir⌘Jvista previa

Retrieve an inbox

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

GET/inboxes/{inbox_id}
Autorización
AuthorizationToken Bearer · headerobligatorio

A BillionSend API key (bs_…).

Parámetros de ruta
inbox_idstringobligatorio

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

Respuestas
200

Inbox

objectstringobligatorio
Valores permitidos:inbox
idstring<uuid>obligatorio
namestringobligatorio
email_addressstringobligatorio
domain_idstring<uuid>obligatorio

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

receiving_addressstring | nullobligatorio
from_namestring | nullobligatorio
unreadintegerobligatorio

Threads with an unread message

draftsintegerobligatorio

Unsent drafts

last_receivedstring | nullobligatorio
created_atstringobligatorio
updated_atstringobligatorio
kindstringobligatorio
Valores permitidos:agenthuman
sharedbooleanobligatorio

On the shared inbox domain

expires_atstring | nullobligatorio
quarantinedintegerobligatorio

Held messages not yet released

pending_approvalintegerobligatorio

Drafts waiting for a person

401

Missing, malformed, unknown or revoked API key

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
404

Not found

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
422

Validation error

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
429

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

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
Pruébalo
Servidor
Autorización
Parámetros
Solicitud
curl -X GET 'https://api.billionsend.com/inboxes/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Respuesta
{
  "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
}

¿Te ha resultado útil esta página?