Get campaign
Get detailed campaign information
Retrieve complete campaign details including configuration, variants, sequences, inboxes, and statistics.
Response Includes
- Campaign configuration (name, schedule, limits)
- Email variants for A/B testing
- Follow-up sequences
- Assigned sender inboxes
- Lead batches and statistics
- Performance metrics (sent, opened, replied, bounced)
Example Usage
import requests
campaign_id = "550e8400-e29b-41d4-a716-446655440000"
response = requests.get(
f"https://api.coldsend.io/api/public/v1/campaigns/{campaign_id}",
headers={"X-API-Key": "your-api-key"}
)
print(response.json())
Authorizations
API key with format cs_live_xxx
Path Parameters
Response
Campaign retrieved successfully
Detailed campaign response schema.
Campaign ID
Campaign name
Campaign status
Current creation step
Daily limit per inbox (None = no limit)
Campaign start date
Campaign timezone
Days of week for sending
Sending window start hour
Sending window start minute
Sending window end hour
Sending window end minute
Email tracking enabled
Lead field mapping
Email sequences
Campaign inboxes
Creator user ID
Team ID
Creation timestamp
Last update timestamp
Launch timestamp
Enable automatic unsubscribe option insertion
Whether ramp-up is enabled for this campaign
Emails/inbox/day added per ramp-up day
Fully-ramped daily cap (emails/inbox/day)
Optional Reply-To email override. None = no Reply-To header.
Email variants for A/B testing the initial email
List of lead batches
Total number of leads
Emails sent
Replies received
Emails opened
Emails bounced
Unsubscribes
Campaign completion rate: (sent + bounced) / total * 100
Campaign success rate: sent / total * 100
Open-to-reply rate: replies / opens * 100

