Get Domains

🌐 Use this endpoint to list all active domains in your organization, along with their mailbox setup, tag, status, and provider.

🔑 Authentication

Requires a valid API token.

GET /api/v1/domains

🔑 Query Parameters

`organization_id` (required)

Your organization's ID. Only domains belonging to this organization are returned.

`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 domain object.

📋 Example Request

GET /api/v1/domains?organization_id=recXXXXXXXXXXXXXX

✅ Response

{
  "total": 1,
  "domains": [
    {
      "id": "recXXXXXXXXXXXXXX",
      "domain": "outreach-one.com",
      "tag": "campaign-q3",
      "redirect": "https://example.com",
      "mailbox_password": "••••••••",
      "order_type": "google",
      "order_id": "recXXXXXXXXXXXXXX",
      "payment_id": "recXXXXXXXXXXXXXX",
      "domain_provider": "Scaledmail",
      "user_id": "recXXXXXXXXXXXXXX",
      "total_mailboxes": 2,
      "mailbox": [
        {
          "first_name": "Jane",
          "last_name": "Doe",
          "alias": "jane"
        }
      ],
      "status": "Active"
    }
  ]
}

ℹ️ Notes

Only domains with an active (non-cancelled, non-pending-cancellation) order are returned.

Use mailbox[].alias with the domain name to build each mailbox's email address ({alias}@{domain}) — or use the Get Mailboxes endpoint, which returns this pre-built as email.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

🔑 Authentication#

🔑 Query Parameters#

organization_id (required)#

password (optional)#

📋 Example Request#

✅ Response#

ℹ️ Notes#

Request