Skip to main content
POST
email.inbox.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string

The ref returned by email.inbox.create. Preferred over address.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
address
string

The inbox's email address, as returned by any inbox capability.

Required string length: 1 - 320

Response

The result

address
string
required

The inbox's email address. It is public: pass it wherever a capability asks for an inbox.

displayName
string

Display name shown to recipients.

status
enum<string>

Whether the inbox currently sends and receives mail.

Available options:
active,
paused
createdAt
string

When the inbox was created, ISO 8601.