Partners

List mailboxes

Mailboxes on the customer's domain, newest first, each with its storage (one batched mail server read per domain, cached for a minute). Requires partner:read.

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

Request

  • Base URL: https://faivelo.com/api/partner
  • URL: https://faivelo.com/api/partner/customers/{id}/domains/{domain}/mailboxes
  • 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

Response

Mailboxes

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.