Skip to main content
GET
/
api
/
public
/
v1
/
domains
/
{domain_id}
/
progress
Get domain setup progress
curl --request GET \
  --url https://api.coldsend.pro/api/public/v1/domains/{domain_id}/progress \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "message": "<string>",
  "domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "domain_name": "<string>",
  "status": "<string>",
  "progress_percentage": 123,
  "is_complete": true,
  "is_failed": true,
  "status_message": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

API key with format cs_live_xxx

Path Parameters

​
domain_id
string<uuid>
required

Response

Progress retrieved successfully

Simple domain setup progress response for customers.

This schema hides ALL internal implementation details - no stages, no step names, no retry counts, no technical failure reasons. Just simple status information.

​
success
boolean
required
​
message
string
required
​
domain_id
string<uuid>
required

Domain ID

​
domain_name
string
required

Domain name

​
status
string
required

Current status: PENDING, IN_PROGRESS, COMPLETED, or FAILED

​
progress_percentage
integer
required

Overall progress (0-100)

​
is_complete
boolean
required

Whether setup is complete

​
is_failed
boolean
required

Whether setup has failed

​
status_message
string | null

User-friendly status message