Skip to main content
GET
Get mailbox

Authorizations

x-api-key
string
header
required

API key (sk-proj-…) from Settings → API Keys. Required for sold API calls outside the Mermail console.

Path Parameters

mailboxId
string
required

Mailbox public_id (UUID), hosted alias id, or current email

Response

Mailbox

id
string

Hosted alias primary key (also accepted as mailboxId)

public_id
string<uuid>

Stable public route id; preferred mailboxId for agents and clients

workspace_id
string
email
string<email>
name
string
email_domain_id
string | null
inbound_provider
string
outbound_provider
string
provider_metadata
object
bucket_id
string | null
settings
object
welcome_onboarding_status
string
inbox_unread_by_category
object

Present on list endpoints only