Get Domain Masking
GET
https://server.scaledmail.com/api/v1/domain-masking
đĩī¸ Use this endpoint to list every domain currently set up with Domain Masking in your organization â both ScaledMail-hosted (internal) and bring-your-own-domain (external) proxies â along with what each one currently points to.
đ Authentication
GET /api/v1/domain-maskingđ Query Parameters
organization_id (required)
đ Example Request
GET /api/v1/domain-masking?organization_id=recXXXXXXXXXXXXXXâ Response
{
"total": 2,
"domains": [
{
"domain_id": "recXXXXXXXXXXXXXX",
"domain": "mask-one.com",
"primary_domain": "brand.com",
"order_type": "google",
"status": "Active"
},
{
"domain_id": "recYYYYYYYYYYYYYY",
"domain": "mask-two.com",
"primary_domain": "othersite.com",
"order_type": "External mailboxes",
"status": "Pending"
}
]
}đ Response Fields
| Field | Description |
|---|---|
total | Total number of Domain Masking proxies returned |
domains[].domain_id | Record ID for this domain â pass this, or the domain name, when calling /swap-domain-masking |
domains[].domain | The masking domain name (the one people visit, which proxies through to primary_domain) |
domains[].primary_domain | The domain this masking domain currently points to |
domains[].order_type | Mailbox provider â "google", "outlook", or "smtp" for a ScaledMail-hosted (internal) domain, or "External mailboxes" if it's a bring-your-own-domain (BYOD) proxy hosted elsewhere |
domains[].status | Current masking status: "Active", "Pending", or "Failed" |
âšī¸ Notes
POST /swap-domain-masking/:old_domain to request a change to a domain's primary_domain â never /swap-redirect, which will reject a masked domain and point you here instead.Request
Query Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://server.scaledmail.com/api/v1/domain-masking?organization_id=undefined' \
--header 'Authorization: Bearer <token>'Response Response Example
{}Modified at 2026-09-21 11:02:06