GoDaddy
Support
API ReferenceEmailEmail APIList all email mailboxes GET

List all email mailboxes

View as Markdown

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

Full description

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

GET
/mailboxes

Authorization

bearerAuth
AuthorizationBearer <token>

Personal Access Token (PAT). Generate one from the developer dashboard. Pass as: Authorization: Bearer <token>.

In: header

Query Parameters

status?Mailbox Status

Filter mailboxes by operational status.

Value in

  • "EXECUTING"
  • "COMPLETED"
  • "FAILED"
  • "DELETED"
page?integer

Page number (1-based). Defaults to 1.

Range1 <= value
Default1
pageSize?integer

Number of mailboxes per page. Defaults to 25, maximum 100.

Range1 <= value <= 100
Default25
field?string

Comma-separated list of top-level Mailbox fields to include in each response object. When omitted, all fields are returned.

totalRequired?boolean

When true, includes totalItems and totalPages in the response body and adds a last navigation link.

Defaultfalse

Header Parameters

X-Request-Id?string

Optional client-generated request correlation identifier. Propagated across services and echoed in the X-Request-Id response header.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/mailboxes?status=COMPLETED&page=2&pageSize=25&field=mailboxId%2CemailAddress%2Cstatus&totalRequired=true"

{  "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"    }  ]}

Last updated on

How is this guide?