# List all email mailboxes (https://developer.godaddy.com/en/docs/references/rest/email/list-mailboxes)

---
title: List all email mailboxes
description: >-
  Returns a paged list of email mailboxes for domains owned by the authenticated
  account, across all supported email platforms.
full: true
---

Full description

\| Returns a paged list of email mailboxes for domains owned by the authenticated account, across all supported email platforms.

## GET /mailboxes

List all email mailboxes

Returns a paged list of email mailboxes for domains owned by the
authenticated account, across all supported email platforms.


### Query parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `status` | unknown | no | Filter mailboxes by operational status. |
| `page` | integer | no | Page number (1-based). Defaults to 1. |
| `pageSize` | integer | no | Number of mailboxes per page. Defaults to 25, maximum 100. |
| `field` | string | no | Comma-separated list of top-level Mailbox fields to include in each response object. When omitted, all fields are returned. |
| `totalRequired` | boolean | no | When true, includes totalItems and totalPages in the response body and adds a last navigation link. |

### Header parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `X-Request-Id` | string <uuid> | no | Optional client-generated request correlation identifier. Propagated across services and echoed in the X-Request-Id response header. |

### Responses

**200** — Paged list of mailboxes.

Content-Type: `application/json`

```json
{
  "items": [
    {
      "mailboxId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "emailAddress": "jane.smith@example.com",
      "mailboxType": "TITAN",
      "firstName": "Jane",
      "lastName": "Smith",
      "displayName": "Jane Smith",
      "status": "COMPLETED",
      "createdAt": "2024-03-15T10:30:00Z",
      "updatedAt": "2024-06-01T08:00:00Z"
    },
    {
      "mailboxId": "a1b2c3d4-js80-7890-abcd-2kd23459hbsk",
      "emailAddress": "john.doe@contoso.com",
      "mailboxType": "TITAN",
      "firstName": "John",
      "lastName": "Doe",
      "displayName": "John Doe",
      "status": "COMPLETED",
      "createdAt": "2024-04-10T09:00:00Z",
      "updatedAt": "2024-06-01T08:00:00Z"
    }
  ],
  "links": [
    {
      "rel": "self",
      "href": "/mailboxes?page=2&pageSize=25"
    },
    {
      "rel": "first",
      "href": "/mailboxes?page=1&pageSize=25"
    },
    {
      "rel": "next",
      "href": "/mailboxes?page=3&pageSize=25"
    },
    {
      "rel": "prev",
      "href": "/mailboxes?page=1&pageSize=25"
    }
  ]
}
```

Schema:

- schema reference: `#/components/schemas/MailboxList`

**400** — Malformed request syntax, missing required field, or invalid field value.

Content-Type: `application/json`

```json
{
  "name": "INVALID_INPUT",
  "correlationId": "req-abc-123",
  "message": "The provided request is invalid.",
  "details": [
    {
      "field": "/username",
      "issue": "PATTERN_VIOLATION",
      "location": "body",
      "description": "Username must contain only letters, digits, dots, underscores, hyphens, and plus signs.\n"
    }
  ]
}
```

Schema:

- schema reference: `#/components/schemas/Error`

**401** — Authentication credentials are missing or invalid.

Content-Type: `application/json`

Schema:

- schema reference: `#/components/schemas/Error`

**403** — Authenticated identity is not authorized to perform this operation.

Content-Type: `application/json`

Schema:

- schema reference: `#/components/schemas/Error`

**429** — Too many requests — rate limit exceeded.

Content-Type: `application/json`

Schema:

- schema reference: `#/components/schemas/Error`

**Security:** requires `bearerAuth`.
