Inboxes

Retrieve an inbox

One inbox by id or by its email address. Requires the inbound:read scope.

get/v1/inboxes/{inbox_id}

Request

  • Base URL: https://smtpfa.st/api
  • URL: https://smtpfa.st/api/v1/inboxes/{inbox_id}
  • Auth: HTTP bearer

Path parameters

inbox_idstring required

The inbox id or its email address

Response

The inbox

objectstring
idstring
namestring
email_addressstring
domain_idstring
receiving_addressunknown
from_namestring nullable
unreadinteger

Threads in the inbox folder with at least one unread message

draftsinteger

Unsent drafts

last_receivedstring date-time nullable

When a thread in this inbox was last active

created_atstring date-time

Example response

{
  "object": "inbox",
  "name": "Customer Support",
  "email_address": "support@example.com",
  "from_name": "Ada from Support"
}

Changes

No recorded changes to this operation across all 1 revision of this API.