---
title: "Get a mailbox"
method: GET
path: "/customers/{id}/domains/{domain}/mailboxes/{address}"
tags: ["Partners"]
---

# Get a mailbox

`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

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

## Path parameters

- `id` string, required
- `domain` string, required
- `address` string, required

## Response `200`

The mailbox

- object
  - `success` boolean
  - `data` PartnerMailbox
    - `id` string
    - `address` string
    - `displayName` string, nullable
    - `active` boolean: False while the customer is paused
    - `createdAt` string, date-time
    - `storage` StorageSummary, nullable: Bytes used and allowed. Null when the mail server could not answer.
      - `usedBytes` integer
      - `limitBytes` integer, nullable
      - `availableBytes` integer, nullable
    - `storageLimitBytes` integer, nullable: The quota you set, or null for the plan's default

## Other responses

- `401`: Missing or invalid API key, or not a partner key
- `403`: The key lacks the required scope, or provisioning is refused (partner paused, customer cap reached)
- `404`: Not found, including any customer that is not yours
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/faivelo/apis/faivelo-api.md) · [All operations](https://skmtc.dev/faivelo/apis/faivelo-api/llms.txt) · [OpenAPI document](https://skmtc.dev/faivelo/apis/faivelo-api/revisions/a7413ddea5d1?raw)