Get campaign

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

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.coldsend.pro/api/public/v1/campaigns/{campaign_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.coldsend.pro/api/public/v1/campaigns/{campaign_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.coldsend.pro/api/public/v1/campaigns/{campaign_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.coldsend.pro/api/public/v1/campaigns/{campaign_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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_start_minute": 123,
  "sending_window_end": 123,
  "sending_window_end_minute": 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
          },
          "content_type": "<string>"
        }
      ]
    }
  ],
  "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,
      "ramp_up_current_day": 0,
      "ramp_up_daily_limit": 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",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "skip_weekends_for_sequences": false,
  "enable_click_tracking": false,
  "enable_unsubscribe": true,
  "ramp_up_enabled": false,
  "ramp_up_increment": 5,
  "ramp_up_max_limit": 50,
  "reply_to": "<string>",
  "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
      },
      "content_type": "<string>"
    }
  ],
  "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,
  "initial_sent_count": 0,
  "followup_sent_count": 0,
  "reply_count": 0,
  "open_count": 0,
  "bounce_count": 0,
  "unsubscribe_count": 0,
  "completion_rate": 0,
  "success_rate": 0,
  "open_to_reply_rate": 0
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Campaigns

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())

GET

api

public

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>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.coldsend.pro/api/public/v1/campaigns/{campaign_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.coldsend.pro/api/public/v1/campaigns/{campaign_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.coldsend.pro/api/public/v1/campaigns/{campaign_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.coldsend.pro/api/public/v1/campaigns/{campaign_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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_start_minute": 123,
  "sending_window_end": 123,
  "sending_window_end_minute": 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
          },
          "content_type": "<string>"
        }
      ]
    }
  ],
  "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,
      "ramp_up_current_day": 0,
      "ramp_up_daily_limit": 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",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "skip_weekends_for_sequences": false,
  "enable_click_tracking": false,
  "enable_unsubscribe": true,
  "ramp_up_enabled": false,
  "ramp_up_increment": 5,
  "ramp_up_max_limit": 50,
  "reply_to": "<string>",
  "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
      },
      "content_type": "<string>"
    }
  ],
  "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,
  "initial_sent_count": 0,
  "followup_sent_count": 0,
  "reply_count": 0,
  "open_count": 0,
  "bounce_count": 0,
  "unsubscribe_count": 0,
  "completion_rate": 0,
  "success_rate": 0,
  "open_to_reply_rate": 0
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

API key with format cs_live_xxx

Path Parameters

campaign_id

string<uuid>

required

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_start_minute

integer

required

Sending window start minute

sending_window_end

integer

required

Sending window end hour

sending_window_end_minute

integer

required

Sending window end minute

enable_tracking

boolean

required

Email tracking enabled

lead_mapping

Lead Mapping · object | null

required

Lead field mapping

Show child attributes

sequences

SequenceResponse · object[]

required

Email sequences

Show child attributes

inboxes

CampaignInboxResponse · object[]

required

Campaign inboxes

Show child attributes

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

workspace_id

string<uuid> | null

Workspace ID the campaign belongs to

skip_weekends_for_sequences

boolean

default:false

When True, follow-up sequence emails scheduled on weekends are deferred to Monday

enable_click_tracking

boolean

default:false

Whether click-through-rate tracking is enabled for this campaign

enable_unsubscribe

boolean

default:true

Enable automatic unsubscribe option insertion

ramp_up_enabled

boolean

default:false

Whether ramp-up is enabled for this campaign

ramp_up_increment

integer

default:5

Emails/inbox/day added per ramp-up day

ramp_up_max_limit

integer

default:50

Fully-ramped daily cap (emails/inbox/day)

reply_to

string | null

Optional Reply-To email override. None = no Reply-To header.

variants

VariantResponse · object[]

Email variants for A/B testing the initial email

Show child attributes

lead_batches

LeadBatchResponse · object[]

List of lead batches

Show child attributes

total_leads

integer

default:0

Total number of leads

sent_count

integer

default:0

Emails sent

initial_sent_count

integer

default:0

Initial emails sent

followup_sent_count

integer

default:0

Follow-up sequence 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

completion_rate

number

default:0

Campaign completion rate: (sent + bounced) / total * 100

success_rate

number

default:0

Campaign success rate: sent / total * 100

open_to_reply_rate

number

default:0

Open-to-reply rate: replies / opens * 100

Campaigns

Sender Accounts

Domains

Leads

Analytics

Replies

Get campaign

Response Includes

Example Usage

Authorizations

Path Parameters

Response