Skip to main content
GET
/
api
/
public
/
v1
/
campaigns
/
{campaign_id}
Get campaign
curl --request GET \
  --url https://api.coldsend.pro/api/public/v1/campaigns/{campaign_id} \
  --header 'X-API-Key: <api-key>'
{
  "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "status": "<string>",
  "current_step": 123,
  "daily_limit_per_inbox": 123,
  "start_date": "2023-11-07T05:31:56Z",
  "timezone": "<string>",
  "sending_days": [
    123
  ],
  "sending_window_start": 123,
  "sending_window_end": 123,
  "enable_tracking": true,
  "lead_mapping": {},
  "sequences": [
    {
      "sequence_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "step_number": 123,
      "trigger_type": "<string>",
      "wait_days": 123,
      "is_active": true,
      "created_at": "2023-11-07T05:31:56Z",
      "variants": [
        {
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "sequence_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "variant_name": "<string>",
          "variant_label": "<string>",
          "subject_template": "<string>",
          "body_template": "<string>",
          "html_template": "<string>",
          "distribution_percent": 123,
          "is_active": true,
          "stats": {
            "sent_count": 123,
            "open_count": 123,
            "reply_count": 123,
            "bounce_count": 123,
            "click_count": 123,
            "open_rate": 123,
            "reply_rate": 123,
            "bounce_rate": 123,
            "click_rate": 123
          }
        }
      ]
    }
  ],
  "inboxes": [
    {
      "inbox_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email_address": "<string>",
      "display_name": "<string>",
      "domain_name": "<string>",
      "emails_sent_today": 123,
      "daily_limit": 123,
      "health_score": 123
    }
  ],
  "created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "launched_at": "2023-11-07T05:31:56Z",
  "variants": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sequence_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "variant_name": "<string>",
      "variant_label": "<string>",
      "subject_template": "<string>",
      "body_template": "<string>",
      "html_template": "<string>",
      "distribution_percent": 123,
      "is_active": true,
      "stats": {
        "sent_count": 123,
        "open_count": 123,
        "reply_count": 123,
        "bounce_count": 123,
        "click_count": 123,
        "open_rate": 123,
        "reply_rate": 123,
        "bounce_rate": 123,
        "click_rate": 123
      }
    }
  ],
  "lead_batches": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "source_type": "<string>",
      "source_name": "<string>",
      "column_mapping": {},
      "lead_count": 123,
      "duplicate_action": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total_leads": 0,
  "sent_count": 0,
  "reply_count": 0,
  "open_count": 0,
  "bounce_count": 0,
  "unsubscribe_count": 0
}

Authorizations

X-API-Key
string
header
required

API key with format cs_live_xxx

Path Parameters

campaign_id
string<uuid>
required

Query Parameters

Response

Campaign retrieved successfully

Detailed campaign response schema.

campaign_id
string<uuid>
required

Campaign ID

name
string
required

Campaign name

status
string
required

Campaign status

current_step
integer
required

Current creation step

daily_limit_per_inbox
integer | null
required

Daily limit per inbox (None = no limit)

start_date
string<date-time> | null
required

Campaign start date

timezone
string
required

Campaign timezone

sending_days
integer[]
required

Days of week for sending

sending_window_start
integer
required

Sending window start hour

sending_window_end
integer
required

Sending window end hour

enable_tracking
boolean
required

Email tracking enabled

lead_mapping
Lead Mapping · object
required

Lead field mapping

sequences
SequenceResponse · object[]
required

Email sequences

inboxes
CampaignInboxResponse · object[]
required

Campaign inboxes

created_by_user_id
string<uuid>
required

Creator user ID

team_id
string<uuid>
required

Team ID

created_at
string<date-time>
required

Creation timestamp

updated_at
string<date-time>
required

Last update timestamp

launched_at
string<date-time> | null
required

Launch timestamp

variants
VariantResponse · object[]

Email variants for A/B testing the initial email

lead_batches
LeadBatchResponse · object[]

List of lead batches

total_leads
integer
default:0

Total number of leads

sent_count
integer
default:0

Emails sent

reply_count
integer
default:0

Replies received

open_count
integer
default:0

Emails opened

bounce_count
integer
default:0

Emails bounced

unsubscribe_count
integer
default:0

Unsubscribes