---
title: "List mailboxes"
method: GET
path: "/mailboxes"
tags: ["Mailboxes"]
---

# List mailboxes

`GET /mailboxes`

## Request

- Base URL: `https://shipmail.to/api/v1`
- URL: `https://shipmail.to/api/v1/mailboxes`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://shipmail.to/api/auth/oauth2/authorize`, token URL `https://shipmail.to/api/auth/oauth2/token`)

List mailboxes with optional domain filter and cursor-based pagination. Use the returned mailbox object's id field as mailbox_id for mailbox-scoped endpoints.

## Query parameters

- `domain_id` string
- `cursor` string
- `limit` integer

## Headers

- `X-Shipmail-Organization` string

## Response `200`

Paginated list of mailboxes.

- object
  - `data` Mailbox[], required
    - `object` 'mailbox', required
    - `id` string, required
    - `domain_id` string, required
    - `address` string, required
    - `display_name` string, nullable, required
    - `suspended_at` string, date-time, nullable, required: When the mailbox was suspended. Null if active.
    - `suspension_reasons` string[], required: Independent reasons currently keeping the mailbox suspended.
    - `auto_reply` object, required
      - `enabled` boolean, required
      - `subject` string, nullable, required
      - `body` string, nullable, required
      - `from_date` string, date-time, nullable, required
      - `to_date` string, date-time, nullable, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
  - `pagination` Pagination, required
    - `next_cursor` string, nullable, required: Cursor for the next page. Null if no more results.
    - `has_more` boolean, required: Whether more results exist beyond this page.
    - `limit` integer, required: Number of items per page.

## Other responses

- `422`: Validation failed.
- `429`: Rate limit exceeded.

---

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