Get Domain

GET

/domains/domain

Fetch a single domain by domainName or componentDomainId, scoped to the authenticated partner.

Returns full domain details including protection status and current forwarding configuration. Exactly one of domainName or componentDomainId must be provided.

By domain name

GET /domains/domain?domainName=acmecorp.com

By component domain ID

GET /domains/domain?componentDomainId=D4XM9JV2S9HMPYFQW393AZHQVD4XM

Notes

forwardTo and emailForwarding are null if no forwarding is configured for the domain.

domainProtectionEnabled reflects whether domain privacy/protection is active.

The domain must belong to a user under the authenticated partner — returns 404 otherwise.

Request

Authorization

API Key

Add parameter in header

cmr-x-api-key

Example:

cmr-x-api-key: ********************

Query Params

Responses

🟢200Success

application/json

Domain fetched successfully

Bodyapplication/json

🟠401Unauthorized

🟠404Not Found

🟠422Validation Error

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://customers.coldmailreseller.com/api/v1/integration/domains/domain?domainName=acmecorp.com&componentDomainId=D4XM9JV2S9HMPYFQW393AZHQVD4XM' \
--header 'cmr-x-api-key: <api-key>'

Response Example

200 - Example 1

{
    "status": 200,
    "message": "Domain fetched successfully",
    "data": {
        "userEmail": "alice@acmecorp.com",
        "domain": "acmecorp.com",
        "status": "ACTIVE",
        "registeredOn": "2024-01-15T10:30:00.000Z",
        "expireOn": "2025-01-15T10:30:00.000Z",
        "purchaseType": "FREE",
        "serviceProvider": "GOOGLE",
        "autoRenew": true,
        "renewedOn": null,
        "domainProtectionEnabled": false,
        "createdAt": "2024-01-15T10:30:00.000Z",
        "updatedAt": "2024-06-01T08:00:00.000Z",
        "forwardTo": null,
        "emailForwarding": null
    }
}

Modified at 2026-08-18 07:34:48

Toggle Domain Auto-Renew

List Available Aged Domains

Get Domain

By domain name#

By component domain ID#

Notes#

Request

Responses

By domain name

By component domain ID

Notes