List domains

curl --request GET \
  --url https://api.coldsend.pro/api/public/v1/domains \
  --header 'X-API-Key: <api-key>'

{
  "domains": [
    {
      "domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "domain_name": "<string>",
      "status": "<string>",
      "mailcow_added": true,
      "cloudflare_verified": true,
      "max_inboxes": 123,
      "current_inboxes": 123,
      "created_at": "<string>"
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "pages": 123,
    "has_next": true,
    "has_prev": true
  },
  "success": true,
  "message": "Domains retrieved successfully"
}

Domains

List domains

List all domains in your workspace

Retrieve a paginated list of custom domains configured for email sending.

Domain Status Values

PENDING: Initial state, waiting to start setup
DNS_CONFIGURING: Setting up DNS infrastructure
DNS_PENDING: Waiting for you to configure DNS records
SERVICES_CONFIGURING: Setting up email services
ACTIVE: Domain is ready to use
FAILED: Setup failed - can retry

Filtering Options

status: Filter by domain status

Pagination

page: Page number (1-based)
limit: Items per page (1-100, default 20)

Example Usage

import requests

response = requests.get(
    "https://api.coldsend.io/api/public/v1/domains?status=ACTIVE",
    headers={"X-API-Key": "your-api-key"}
)

print(response.json())

GET

api

public

domains

List domains

curl --request GET \
  --url https://api.coldsend.pro/api/public/v1/domains \
  --header 'X-API-Key: <api-key>'

{
  "domains": [
    {
      "domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "domain_name": "<string>",
      "status": "<string>",
      "mailcow_added": true,
      "cloudflare_verified": true,
      "max_inboxes": 123,
      "current_inboxes": 123,
      "created_at": "<string>"
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "pages": 123,
    "has_next": true,
    "has_prev": true
  },
  "success": true,
  "message": "Domains retrieved successfully"
}

Authorizations

X-API-Key

string

header

required

API key with format cs_live_xxx

Query Parameters

page

integer

default:1

Page number

Required range: x >= 1

limit

integer

default:20

Items per page

Required range: 1 <= x <= 100

status_filter

string | null

Filter by status

Response

Domains retrieved successfully

Response for listing domains.

domains

DomainListItem · object[]

required

List of domains

Show child attributes

pagination

PaginationMeta · object

required

Pagination information

Show child attributes

success

boolean

default:true

message

string

default:Domains retrieved successfully

Get bulk SMTP job progress Add domain