INinkbox
Mailboxes

Get Mailbox

Changed on
get/api/v1/mail/mailboxes/{email_address}

Request

  • Base URL
    https://api.inkbox.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.inkbox.ai/api/v1/mail/mailboxes/{email_address}
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

email_addressstring required

Query parameters

include_unread_countboolean

Response

Successful Response

idstring uuid required
email_addressstring required
status'active' | 'paused' | 'deleted'
sending_domainstring

Bare domain the mailbox sends from, derived from email_address. Matches the platform default (inkboxmail.com) or the customer's verified custom domain.

filter_mode'whitelist' | 'blacklist' required
inbound_filter_mode'whitelist' | 'blacklist'
outbound_filter_mode'whitelist' | 'blacklist'
agent_identity_idstring uuid nullable

ID of the agent identity that owns this mailbox, or null on tombstones / system mailboxes.

created_atstring date-time required
updated_atstring date-time required
storage_used_bytesinteger

Live storage used by this inbox, in bytes.

storage_limit_bytesinteger nullable

Resolved plan-tiered storage cap in bytes; null when the route did not resolve it (the ORM does not carry the cap).

signature_htmlstring nullable
signature_textstring nullable
signature_enabledboolean
unread_countinteger nullable

Changes

  • f3dcdb50fbaaRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 8fdfe5fd9d6bRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status