---
title: "Get a mailbox"
method: GET
path: "/api/mailboxes/{id}"
tags: ["Mailboxes"]
---

# Get a mailbox

`GET /api/mailboxes/{id}`

## Request

- Base URL: `https://api.sendly.now`
- URL: `https://api.sendly.now/api/mailboxes/{id}`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `better-auth.session_token`
  - OAuth 2 (authorization code, authorization URL `https://app.sendly.now/api/auth/oauth2/authorize`, token URL `https://app.sendly.now/api/auth/oauth2/token`, scopes: `mailboxes:read`)

One mailbox, with the IMAP and SMTP host/port/username a mail client needs. The password is not included: mailbox credentials are app passwords, created separately and shown once.

Requires the `mailboxes:read` scope — View the mailboxes on your domains and their settings.

## Path parameters

- `id` string, uuid, required

## Response `200`

Mailbox with connection settings

- object
  - `data` MailboxDetail, required: A mailbox plus its IMAP/SMTP connection settings.
    - `address` string, email, required: The full mailbox address, e.g. `support@superbooks.io`.
    - `createdAt` string, date-time, required
    - `displayName` string, nullable, required
    - `domainId` string, uuid, required: The verified domain this mailbox lives on.
    - `id` string, uuid, required
    - `quotaBytes` number, nullable, required: Always null. Mailbox quotas are not implemented — the value was never applied to the mail account — so this field reports the absence rather than a number nothing enforces.
    - `status` 'PROVISIONING' | 'ACTIVE' | 'SUSPENDED' | 'FAILED', required: `PROVISIONING` while the mail account is being created, `ACTIVE` once it can receive, `SUSPENDED` when receiving is paused, `FAILED` when provisioning did not complete. A `FAILED` mailbox can be re-created with the same address — the retry reclaims the row.
    - `settings` object, required: Host, port and username for connecting a mail client. The PASSWORD is not here and is never returned by this endpoint — create an app password for that.
      - `imap` object, required
        - `host` string, required
        - `port` integer, required
        - `security` string, required: Transport security, e.g. `SSL/TLS`.
        - `username` string, required: The mailbox address — it is also the login.
      - `smtp` object, required
        - `host` string, required
        - `port` integer, required
        - `security` string, required: Transport security, e.g. `SSL/TLS`.
        - `username` string, required: The mailbox address — it is also the login.
  - `success` true, required

## Other responses

- `400`: Validation error
- `401`: Unauthorized — missing or invalid auth
- `403`: Forbidden — insufficient permissions or project disabled
- `404`: Resource not found
- `429`: Rate limit or billing limit exceeded
- `500`: Internal server error

---

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