Skip to main content
GET
/
api
/
public
/
v1
/
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
string | null

Filter by status

Response

Domains retrieved successfully

Response for listing domains.

domains
DomainListItem · object[]
required

List of domains

pagination
PaginationMeta · object
required

Pagination information

success
boolean
default:true
message
string
default:Domains retrieved successfully