Partners

Get a mailbox

One mailbox with its storage: bytes used, the quota the mail server enforces, and what is left. Requires partner:read.

get/customers/{id}/domains/{domain}/mailboxes/{address}

Request

  • Base URL: https://faivelo.com/api/partner
  • URL: https://faivelo.com/api/partner/customers/{id}/domains/{domain}/mailboxes/{address}
  • Auth: HTTP bearer

Path parameters

idstring required
Example:cmtumr8yj000bd7xabjjsnil8

The customer id returned when the customer was created

domainstring required

The customer's domain name, e.g. smiledental.example

addressstring required

Full mailbox address, URL-encoded, e.g. hello%40smiledental.example

Response

The mailbox

successboolean

Example response

{
  "success": true,
  "data": {
    "address": "hello@smiledental.example",
    "storage": {
      "usedBytes": 3221225472,
      "limitBytes": 53687091200,
      "availableBytes": 50465865728
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.