Skip to main content
GET
Get a mailbox

Authorizations

Authorization
string
header
required

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

Path Parameters

mailbox_id
string<uuid>
required

Response

Successful Response

connection_status
enum<string>
required

Whether the mailbox's grant currently authenticates.

Available options:
connected,
disconnected
created_at
string<date-time>
required
daily_send_limit
integer
required
disconnected_at
string<date-time> | null
required
disconnected_reason
string | null
required
display_name
string
required
email_address
string
required
id
string<uuid>
required
provider
enum<string>
required

Which email provider a mailbox connects through.

Phase 1 ships Google Workspace only; every provider is implemented behind providers.EmailProviderBase so Office 365 and IMAP/SMTP can be added later without touching callers.

GOOGLE_WORKSPACE holds a per-mailbox OAuth grant (consent screen, refresh token). GOOGLE_WORKSPACE_DWD holds no grant at all: tokens are minted on demand via domain-wide delegation as the platform service account, so its rows carry an empty refresh_token forever — the path imported fleets (e.g. InboxKit) connect through.

Available options:
google_workspace,
google_workspace_dwd
sender_first_name
string
required
sender_last_name
string
required
sender_profile_id
string<uuid> | null
required
signature_text
string
required
updated_at
string<date-time>
required
bounce_rate
number | null

DSNs / accepted sends, lifetime.

last_verified_at
string<date-time> | null

MBX-04: when a read+send verification last succeeded.

reply_rate
number | null

Genuine replies / accepted sends, lifetime.

usage
MailboxUsageReadSchema · object | null