Mailboxes

List mailboxes

Returns all mailboxes, optionally filtered by domain. Requires scope mailboxes:read. Mailbox-restricted keys only see their bound mailbox; agent keys only see mailboxes they created or were granted.

get/mailboxes

Request

Base URL: https://faivelo.com/api/v1
URL: https://faivelo.com/api/v1/mailboxes
Auth: HTTP bearer

Query parameters

domainstring

Filter by domain name

Response

Mailbox list

successboolean

Example response

{
  "success": true,
  "data": [
    {
      "localPart": "jane",
      "fullAddress": "jane@yourdomain.com",
      "displayName": "Jane Doe",
      "active": true,
      "storage": {
        "usedBytes": 3221225472,
        "limitBytes": 53687091200,
        "availableBytes": 50465865728
      }
    }
  ]
}

Changes

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