Skip to main content
GET
Get a mailbox

Authorizations

Authorization
string
header
required

Sendmux API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.

Headers

If-None-Match
string

Weak ETag from a previous response. Returns 304 when unchanged.

Path Parameters

public_id
string
required

Mailbox public ID

Response

Mailbox

meta
object
required
ok
enum<boolean>
required
Available options:
true
data
object
required