Get Mailboxes by Domain ID

📬 Use this endpoint to list all mailboxes on a single domain, with each mailbox's alias, email address, and password.
To find a domain's domain_id, use the Get Domains endpoint.
→ Get Domains

🔑 Authentication

Requires a valid API token.

GET /api/v1/mailboxes/:domain_id

🔑 Path Parameters

`domain_id` (required)

The domain's record ID, as returned by GET /domains (domains[].id).

🔑 Query Parameters

`organization_id` (required)

Your organization's ID. The domain must belong to this organization.

`password` (optional)

Controls whether mailbox_password is included in the response.

Omit, or pass "true" (default) — mailbox_password is included.

Pass "false" — mailbox_password is omitted from every mailbox object.

📋 Example Request

GET /api/v1/mailboxes/recXXXXXXXXXXXXXX?organization_id=recXXXXXXXXXXXXXX

✅ Response

{
  "total": 1,
  "mailboxes": [
    {
      "first_name": "Jane",
      "last_name": "Doe",
      "alias": "jane",
      "domain_id": "recXXXXXXXXXXXXXX",
      "payment_id": "recXXXXXXXXXXXXXX",
      "status": "Active",
      "tag": "campaign-q3",
      "mailbox_password": "••••••••",
      "email": "jane@outreach-one.com",
      "order_type": "google",
      "order_id": "recXXXXXXXXXXXXXX"
    }
  ]
}

⚠️ Error Responses

`domain_id` does not exist

{ "message": "Unable to get mailboxes or domain ID does not exist" }

ℹ️ Notes

profile_picture is included per-mailbox when one was set on the order — otherwise the field is omitted.

If the domain has no mailboxes yet, mailboxes is returned as an empty array.

If domain_id exists but belongs to a different organization than organization_id, this does not error — it responds 200 with total: 0 and mailboxes: null (or mailboxes: [] if ?password=false is passed).

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Get Mailboxes by Domain ID

🔑 Authentication#

🔑 Path Parameters#

domain_id (required)#

🔑 Query Parameters#

organization_id (required)#

password (optional)#

📋 Example Request#

✅ Response#

⚠️ Error Responses#

domain_id does not exist#

ℹ️ Notes#

Request

Responses