Skip to main content
GET
Get inbox

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Response

Inbox details

Inbox details

id
string

OpenMail inbox ID

podId
string

ID of the pod this inbox belongs to. Inboxes created without an explicit pod land in your account's default pod.

address
string<email>

Full email address

displayName
string | null

Sender display name

webhookUrl
string | null

URL that receives signed webhook events for this inbox, if set. Overrides the account-level webhook for this inbox only.

webhookSecret
string | null

Signing secret for this inbox's webhook. Only present in the response when the secret is generated or rotated (on create, on first setting a webhook URL, or via the rotate-secret endpoint) — it is never returned afterward.

forwardTo
string | null

Address that receives copies of this inbox's inbound mail, if set.

forwardWhen
enum<string> | null

Which inbound mail is forwarded. Null when forwarding is not set.

Available options:
always,
needs_human,
webhook_failed,
null
forwardStatus
enum<string> | null

pending until the address confirms via the emailed link (members of your organisation are confirmed at once); active once copies are flowing; disabled when forwarding paused itself after the address hard-bounced repeatedly or complained — set forwardTo again to resume. Null when forwarding is not set.

Available options:
pending,
active,
disabled,
null
createdAt
string<date-time>