Sign in
Mailbox API

List mailbox quotas

Changed on

Returns a cursor-paginated list of quota usage and limits for the authenticated mailbox.

get/mailbox/quotas

Request

  • Base URL: https://app.sendmux.ai/api/v1
  • URL: https://app.sendmux.ai/api/v1/mailbox/quotas
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.sendmux.ai/oauth/authorize, token URL https://app.sendmux.ai/oauth/token, scopes: mailbox.read)

Query parameters

cursorstring
limitinteger
namestring
scope'account' | 'domain' | 'global'
resource_type'count' | 'octets'
typestring
sort_by'name' | 'used'
sort_direction'asc' | 'desc'
mailbox_idstring

Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.

Response

Quota list

oktrue required

Example response

{
  "data": [
    {
      "resource_type": "octets",
      "scope": "account"
    }
  ]
}

Changes