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

Pass "true" — mailbox_password is included.

📋 Example Requests

Example 1 — default (no passwords)

GET /api/v1/domains?organization_id=recXXXXXXXXXXXXXX

{
  "total": 1,
  "domains": [
    {
      "id": "recXXXXXXXXXXXXXX",
      "domain": "outreach-one.com",
      "tag": "campaign-q3",
      "redirect": "https://example.com",
      "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"
    }
  ]
}

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

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

{
  "total": 1,
  "domains": [
    {
      "id": "recXXXXXXXXXXXXXX",
      "domain": "outreach-one.com",
      "tag": "campaign-q3",
      "redirect": "https://example.com",
      "mailbox_password": "Sup3rSecret!",
      "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"
    }
  ]
}

📋 Response Fields

Field	Description
`total`	Total number of domains returned
`domains[].id`	Airtable record ID for this domain
`domains[].domain`	The domain name
`domains[].tag`	Custom tag set on this domain's order (empty string if none)
`domains[].redirect`	Redirect URL configured for this domain (empty string if none)
`domains[].mailbox_password`	Shared mailbox password for this domain, in plaintext. Only present when `?password=true` is passed — omitted by default
`domains[].order_type`	Provider type: `"google"`, `"outlook"`, or `"smtp"`
`domains[].order_id`	Airtable record ID of the order this domain belongs to
`domains[].payment_id`	Airtable record ID of the payment this domain belongs to
`domains[].domain_provider`	Registrar/provider this domain was purchased through (e.g. `"Scaledmail"`)
`domains[].user_id`	Airtable record ID of the user who owns this domain
`domains[].total_mailboxes`	Number of mailboxes set up on this domain
`domains[].mailbox`	Array of mailbox objects on this domain — `first_name`, `last_name`, `alias` (and `profile_picture` if set)
`domains[].status`	Current order status for this domain

ℹ️ 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 Requests#

Example 1 — default (no passwords)#

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

📋 Response Fields#

ℹ️ Notes#

Request

Responses