GET
/inboxes/{inbox_id}Get an inbox by ID or email address
Retrieves a single inbox by its ID or email address. Use an email address for a case-insensitive address lookup, or a UUID to look up the inbox by ID.
inbox_idstringrequired
The inbox ID or email address to look up. Email address matching is case-insensitive.
200Returns the inbox object, including its address, domain ID, forwarding address, sender name, unread and draft counts, latest received email timestamp, and creation timestamp.
objectstringrequired
The object type. Always `inbox`.
idstringrequired
The ID of the inbox.
namestringrequired
Internal name for the inbox. Recipients do not see it. Falls back to the inbox email address.
email_addressstringrequired
The address of the inbox.
domain_idstringrequired
The ID of the domain that owns the address.
receiving_addressstringrequired
The address to forward mail to when forwarding is enabled. `null` otherwise.
from_namestringrequired
The name recipients see when mail is sent from this inbox. `null` when not set.
unreadintegerrequired
The number of unread threads in the Inbox folder.
draftsintegerrequired
The number of unsent drafts.
last_receivedstringrequired
ISO 8601 timestamp of the newest received email in the Inbox folder. `null` when the folder has no received email.
created_atstringrequired
ISO 8601 timestamp when the inbox was created.
Error handling
If the inbox_id path parameter contains @, it must be a valid email address; any other value must be a UUID.