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 Airtable 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. Opt-in — plaintext credentials are withheld unless you explicitly ask for them.

Omit, or pass anything other than "true" (default) — mailbox_password is omitted from every mailbox object.

Pass "true" — mailbox_password is included.

📋 Example Requests

Example 1 — default (no passwords)

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

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

Example 2 — `?password=true` (includes `mailbox_password`)

GET /api/v1/mailboxes/recXXXXXXXXXXXXXX?organization_id=recXXXXXXXXXXXXXX&password=true

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

📋 Response Fields

Field	Description
`total`	Total number of mailboxes returned
`mailboxes[].first_name`	Mailbox first name
`mailboxes[].last_name`	Mailbox last name
`mailboxes[].alias`	The mailbox's local part (before the `@`)
`mailboxes[].domain_id`	Airtable record ID of the domain this mailbox belongs to
`mailboxes[].payment_id`	Airtable record ID of the payment this domain belongs to
`mailboxes[].status`	Current order status of the domain this mailbox is on
`mailboxes[].tag`	Custom tag set on this domain's order (empty string if none)
`mailboxes[].mailbox_password`	Plaintext password for this mailbox. Only present when `?password=true` is passed — omitted by default
`mailboxes[].email`	Full email address (`alias@domain`)
`mailboxes[].order_type`	Provider type: `"google"`, `"outlook"`, or `"smtp"`
`mailboxes[].order_id`	Airtable record ID of the order this domain belongs to

⚠️ 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: [] by default, or mailboxes: null if ?password=true 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 Requests#

Example 1 — default (no passwords)#

Example 2 — ?password=true (includes mailbox_password)#

📋 Response Fields#

⚠️ Error Responses#

domain_id does not exist#

ℹ️ Notes#

Request

Responses