inboxes

Get inbox

Retrieve a single inbox by its ID, including its address, display name, and creation time.

get/v1/inboxes/{id}

Request

  • Base URL: https://api.openmail.sh
  • URL: https://api.openmail.sh/v1/inboxes/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Response

Inbox details

idstring

OpenMail inbox ID

podIdstring

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

addressstring email

Full email address

displayNamestring nullable

Sender display name

webhookUrlstring nullable

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

webhookSecretstring nullable

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.

forwardTostring nullable

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

forwardWhen'always' | 'needs_human' | 'webhook_failed' | 'null' nullable

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

forwardStatus'pending' | 'active' | 'disabled' | 'null' nullable

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.

createdAtstring date-time

Changes

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