Skip to main content
GET
Get all campaigns
🎯 Key Features:
  • Filter by campaign type
  • Pagination support
  • Sort by date or performance
  • Include campaign statistics
📝 Content is not included: To keep pages small, list responses omit htmlCode, plainText and previewText. Use Get campaign by ID to read a campaign’s content. 📈 Status Values:
  • 0 - Draft
  • 1 - Scheduled
  • 2 - Sending
  • 3 - Sent
  • 4 - Quarantined
  • 5 - Evaluating
  • 6 - EvaluationFailed
  • 7 - WarmingUp

Authorizations

​
X-Team-ApiKey
string
header
required

Team API key for authentication. Find your API key in SendX Settings → Team API Key.

Example:

Query Parameters

​
offset
integer
default:0

Number of campaigns to skip

Required range: x >= 0
​
limit
integer
default:10

Maximum number of campaigns to return

Required range: 1 <= x <= 100
​
campaignType
enum<string>
default:all

Filter by campaign type

Available options:
all,
draft,
scheduled,
sent

Response

✅ Campaigns retrieved successfully

​
id
string
required

Campaign ID, with prefix

Pattern: ^campaign_[a-zA-Z0-9]{22}$
Example:

"campaign_4vK3WFhMgvOwUNyaL4QxCD"

​
name
string
required

Internal campaign name

Example:

"Summer Sale 2024"

​
subject
string
required

Email subject line

Example:

"🌞 Summer Sale - 50% Off Everything!"

​
sender
string
required

Sender id

Example:

"sender_4vK3WFhMgvOwUNyaL4QxCD"

​
status
enum<integer>
required

Campaign status.

Values:

  • 0 - Draft
  • 1 - Scheduled
  • 2 - Sending
  • 3 - Sent
  • 4 - Quarantined
  • 5 - Evaluating
  • 6 - Evaluation failed
  • 7 - Warming up
  • 8 - Warming up paused
  • 9 - Spread sending paused
Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
Example:

1

​
scheduleType
enum<integer>
default:0
required

Campaign scheduling type.

Values:

  • 0 - Schedule later
  • 1 - Send Now
Available options:
0,
1,
2,
3
​
scheduleCondition
string
required

datetime for scheduled campaigns (required if scheduleType=1)

Example:

"2024-12-30"

​
includedLists
string[]
required

Included list IDs with prefix

Pattern: ^list_[a-zA-Z0-9]{22}$
Example:
​
excludedLists
string[]
required

Excluded list IDs with prefix

Pattern: ^list_[a-zA-Z0-9]{22}$
Example:
​
htmlCode
string

HTML email content. Matches the htmlCode field accepted on create/update.

Returned by GET /campaign/{id}, POST /campaign, and PUT /campaign/{id} only. Omitted from the GET /campaign list response — campaign HTML is large, so the list endpoint stays lean. Fetch a single campaign to read it.

Example:

"<html><body><h1>Summer Sale</h1></body></html>"

​
plainText
string

Plain text email content. Currently auto-generated from htmlCode on create/update rather than taken from the request. Omitted from the list response, like htmlCode.

Example:

"Summer Sale"

​
previewText
string

Email preview text (preheader). Omitted from the list response, like htmlCode.

Example:

"Limited time offer - Shop now!"

​
timeCondition
string

Time-related condition for the campaign

Example:

"9:00 AM"

​
timezone
string

Campaign timezone

Example:

"America/New_York"

​
smartSend
boolean

Timezone for the scheduled send

Example:

"America/New_York"

​
sendInContactsTimezone
boolean

Send at specified time in each contact's timezone

Example:

true

​
preferredTimeCondition
string

Preferred time condition, in case of smartSend and sendInContactTimeZone

Example:

"10:00 AM"

​
preferredTimezone
string

Preferred timezone for smart send optimization

Example:

"America/Los_Angeles"

​
strategy
string

Campaign delivery strategy

Example:

"Batch Sending"

​
includedSegments
string[]

Included segment IDs

Pattern: ^segment_[a-zA-Z0-9]{22}$
Example:
​
includedTags
string[]

Included tag IDs with prefix

Pattern: ^tag_[a-zA-Z0-9]{22}$
Example:
​
excludedSegments
string[]

Excluded segment IDs

Pattern: ^segment_[a-zA-Z0-9]{22}$
Example:
​
excludedTags
string[]

Excluded tag IDs with prefix

Pattern: ^tag_[a-zA-Z0-9]{22}$
Example:
​
isArchived
boolean

Whether the campaign has been archived

Example:

false

​
campaignScreenshotUrl
string

URL of the generated campaign preview screenshot. Empty until the screenshot job completes.

​
autowarmup
boolean

Whether autowarmup is enabled for this campaign

Example:

false

​
autowarmupType
integer

Autowarmup pacing type

Example:

0

​
autowarmupStartLevel
integer

Autowarmup starting level

Example:

0

​
plainwarmup
boolean

Whether plain warmup is enabled for this campaign

Example:

false

​
plainwarmupStartLevel
integer

Plain warmup starting level

Example:

0