Get Campaigns List

Query marketing campaigns with pagination (up to 100 per page)

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
enum

Campaign type (1 = A/B campaign, 2 = normal campaign; returns both types when omitted)

Allowed:
integer
enum

Campaign status (-1 = failed, 0 = pending send, 1 = sending, 2 = completed, 3 = manually ended)

Allowed:
string

Campaign name (fuzzy match)

integer
enum

Recipient range type (0 = all contacts, 1 = segment, 2 = tag)

Allowed:
string

Recipient range Id (all when sendListType=0; segment Id when sendListType=1; tag Id when sendListType=2)

integer
≥ 0
Defaults to 0

Query start position (pagination parameter, defaults to 0)

integer
1 to 100
Defaults to 10

Number of results returned per query (pagination parameter, range 1-100, defaults to 10)

Responses

Language
Credentials
Bearer
base64(apiUser:apiKey)
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json