List campaigns

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

{
  "success": true,
  "message": "<string>",
  "campaigns": [
    {
      "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "status": "<string>",
      "current_step": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "launched_at": "2023-11-07T05:31:56Z",
      "enable_tracking": false,
      "total_leads": 0,
      "sent_count": 0,
      "reply_count": 0,
      "open_count": 0,
      "bounce_count": 0,
      "unsubscribe_count": 0
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "pages": 123,
    "has_next": true,
    "has_prev": true
  }
}

Campaigns

List campaigns

List all campaigns in your workspace

Retrieve a paginated list of campaigns with filtering and sorting options.

Filtering Options

status: Filter by campaign status (DRAFT, ACTIVE, PAUSED, COMPLETED, FAILED)
search: Search campaigns by name (case-insensitive partial match)
days: Filter campaigns created in the last N days

Sorting Options

sort_by: Field to sort by (name, status, created_at, launched_at, sent_count, reply_count)
sort_order: Sort direction (asc, desc)

Pagination

page: Page number (1-based)
limit: Items per page (1-100, default 20)

Example Usage

import requests

response = requests.get(
    "https://api.coldsend.io/api/public/v1/campaigns?status=ACTIVE&sort_by=created_at&sort_order=desc",
    headers={"X-API-Key": "your-api-key"}
)

print(response.json())

GET

api

public

campaigns

List campaigns

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

{
  "success": true,
  "message": "<string>",
  "campaigns": [
    {
      "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "status": "<string>",
      "current_step": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "launched_at": "2023-11-07T05:31:56Z",
      "enable_tracking": false,
      "total_leads": 0,
      "sent_count": 0,
      "reply_count": 0,
      "open_count": 0,
      "bounce_count": 0,
      "unsubscribe_count": 0
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total": 123,
    "pages": 123,
    "has_next": true,
    "has_prev": true
  }
}

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_filter

string | null

Filter by status

string | null

Search by name

sort_by

string | null

Sort field

sort_order

string | null

Sort order (asc/desc)

days

integer | null

Filter by days since creation

Required range: x >= 1

Response

Campaigns retrieved successfully

Response for listing campaigns.

success

boolean

required

message

string

required

campaigns

CampaignListItem · object[]

required

List of campaigns

Show child attributes

pagination

PaginationMeta · object

required

Pagination information

Show child attributes

Create campaign