Get campaign list

Description

Retrieve the list of campaigns — combinations of mailings and scenarios into unified marketing strategies.

Access rights

To use this method, the API token must have:

• Campaigns — Run
• Access to the groups where the campaigns are located

Configure permissions in Settings — Tokens.

Request URL

Method: POST

https://example.com/api/v1.1/scampaigns/list

Request parameters

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
format	string	"json"	No	Response format default – "json"
from_id	int	1	No	ID of the first campaign in the response default – 1
limit	int	2	No	Limit on the number of returned items default – 1000
state	string	"active"	No	Campaign status. One of: "cloning", "inactive", "waiting", "active", "completed", "deleted"
ui_tags	[]string	["tag1", "tag2"]	No	Tag list to filter campaigns default – []
groups	[]string	["group1", "group2"]	No	Group names to filter campaigns default – []
groups_id	[]int	[0, 1]	No	Group IDs to filter campaigns default – []
attributes	JSON object	"attributes": { "season": ["spring_2025", "summer_2025"] }	No	Attribute values to filter campaigns

Request example

JSON

{
  "token": "abcdefghijklmnqrstuvwxyz",
  "limit": 1
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <limit>1</limit>
</xml>

Response example

JSON

{
  "data": [
    {
      "id": 42,
      "is_delete": false,
      "createtime": "2025-08-22T07:15:29.711Z",
      "updatetime": "2025-08-22T09:13:24.264Z",
      "updated_user": "test",
      "name": "Seasonal sale",
      "description": "",
      "tags": [],
      "state": "inactive",
      "audience": {
        "state": "ready",
        "seg_id": 124,
        "list_id": 49,
        "extension_conf": {
          "workflows": {"ids": []},
          "triggers": {"ids": []},
          "broadcasts": {"ids": []},
          "regulars": {"ids": [556]},
          "abns": {"ids": []},
          "placements": {"ids": []}
        },
        "lcg": {
          "ignore_entities": {
            "workflows": {"ids": []},
            "triggers": {"ids": []},
            "broadcasts": {"ids": []},
            "regulars": {"ids": []},
            "abns": {"ids": []},
            "placements": {"ids": []}
          },
          "size_formation_settings": {
            "limit": 0,
            "percent": "10.00"
          }
        }
      },
      "active_period": {
        "settings": {
          "tz": "Europe/Moscow",
          "end_at": "2025-08-23T10:36:25.099+03:00"
        },
        "history": {
          "start": "2025-08-22T12:13:18.813+03:00",
          "stop": "2025-08-22T12:13:24.264+03:00"
        }
      },
      "control_group_counter": 3002,
      "marketing_activities_counter": 1,
      "refresh_data": {
        "state": "completed",
        "progress": 100,
        "task_start_date": "2025-08-22T09:13:19.926Z", 
        "task_end_date": "2025-08-22T09:13:20.048Z"
      },
      "group_id": 0,
      "groups_id": [0], 
      "groups": [
        {
          "id": 0,
          "name": "main"
        }
      ],
      "attributes": {
        "season": "spring_2025",
        "branch": "marketing"
      }
    }
  ],
  "error": 0,
  "error_text": "",
  "total_count": 5
}

XML

<xml>
  <error>0</error>
  <error_text>Successful operation</error_text>
  <data>
    <id>42</id>
    <is_delete>false</is_delete>
    <createtime>2025-08-22T07:15:29.711Z</createtime>
    <updatetime>2025-08-22T09:13:24.264Z</updatetime>
    <updated_user>test</updated_user>
    <name>Seasonal sale</name>
    <description/>
    <ui_tags/>
    <state>inactive</state>
    <audience>
      <state>ready</state>
      <seg_id>124</seg_id>
      <list_id>49</list_id>
      <extension_conf>
        <workflows><ids/></workflows>
        <triggers><ids/></triggers>
        <broadcasts><ids/></broadcasts>
        <regulars><ids><id>556</id></ids></regulars>
        <abns><ids/></abns>
        <placements><ids/></placements>
      </extension_conf>
      <lcg>
        <ignore_entities>
          <workflows><ids/></workflows>
          <triggers><ids/></triggers>
          <broadcasts><ids/></broadcasts>
          <regulars><ids/></regulars>
          <abns><ids/></abns>
          <placements><ids/></placements>
        </ignore_entities>
        <size_formation_settings>
          <limit>0</limit>
          <percent>10.00</percent>
        </size_formation_settings>
      </lcg>
    </audience>
    <active_period>
      <settings>
        <tz>Europe/Moscow</tz>
        <end_at>2025-08-23T10:36:25.099+03:00</end_at>
      </settings>
      <history>
        <start>2025-08-22T12:13:18.813+03:00</start>
        <stop>2025-08-22T12:13:24.264+03:00</stop>
      </history>
    </active_period>
    <control_group_counter>3002</control_group_counter>
    <marketing_activities_counter>1</marketing_activities_counter>
    <refresh_data>
      <state>completed</state>
      <progress>100</progress>
      <task_start_date>2025-08-22T09:13:19.926Z</task_start_date>
      <task_end_date>2025-08-22T09:13:20.048Z</task_end_date>
    </refresh_data>
    <group_id>0</group_id>
    <groups_id>0</groups_id>
    <groups>
      <group>
        <id>0</id>
        <name>main</name>
      </group>
    </groups>
    <attributes>
      <season>spring_2025</season>
      <branch>marketing</branch>
    </attributes>
  </data>
  <total_count>5</total_count>
</xml>

Returned parameters

Top-level fields

Parameter	Type	Description
error	int	Error code. 0 – successful execution
error_text	string	Error description
total_count	int	Total number of campaigns
next_from_id	int	Pointer for retrieving the next batch of data
data	array	Array of campaign objects

The data object

Contains core campaign information.

Parameter	Type	Description
id	int	Campaign ID
name	string	Campaign name
description	string	Campaign description
list_id	int	Profile database ID
seg_id	int	Segment ID
state	string	Current campaign status
createtime	string	Campaign creation date and time
updatetime	string	Last update date and time
updated_user	string	User who made the last changes
is_delete	boolean	Indicates whether the campaign is deleted
tags	array	Campaign tags
groups	array	User groups that have access to the campaign
group_id	int	Main campaign group ID
groups_id	array	Array of campaign group IDs
marketing_activities_counter	int	Number of marketing activities (mailings, scenarios, placements)
control_group_counter	int	Number of profiles in the control group
attributes	object	Campaign attributes
refresh_data	object	Information about the campaign data refresh process

The active_period object

Contains information about the campaign timeframe.

Parameter	Type	Description
settings	object	Planned active period settings
history	object	Actual active period data

settings — planned campaign timing

Parameter	Type	Description
tz	string	Campaign time zone
start_at	string	Planned campaign start date
end_at	string	Planned campaign end date

history — actual campaign data

Parameter	Type	Description
start	string	Actual campaign start date
stop	string	Actual campaign stop date

The audience object

Contains campaign audience settings and information.

Parameter	Type	Description
state	string	Audience building status
seg_id	int	Segment ID
list_id	int	Profile database ID
extension_conf	object	Audience expansion settings via marketing activities
lcg	object	Local control group settings

extension_conf

Activities that expand the campaign audience.

Parameter	Type	Description
workflows	object	Scenarios that expand the audience
triggers	object	Triggered mailings that expand the audience
broadcasts	object	Broadcast mailings that expand the audience
regulars	object	Regular mailings that expand the audience
abns	object	A/B tests that expand the audience
placements	object	Placements that expand the audience

Each of these objects contains an array of IDs of the corresponding activities.

lcg — Local control group settings

Parameter	Type	Description
ignore_entities	object	Activities that ignore LCG
size_formation_settings	object	Local control group size settings

ignore_entities — activities excluded from LCG audience building

Parameter	Type	Description
workflows	object	Scenarios that ignore LCG
triggers	object	Triggers that ignore LCG
broadcasts	object	Broadcast mailings that ignore LCG
regulars	object	Regular mailings that ignore LCG
abns	object	A/B tests that ignore LCG
placements	object	Placements that ignore LCG

size_formation_settings — LCG size settings

Parameter	Type	Description
limit	int	Maximum number of profiles in LCG
percent	string	LCG share of the total audience in percent

The refresh_data object

Contains information about the campaign data refresh process.

Parameter	Type	Description
state	string	Data refresh task status
progress	int	Task progress in percent
task_start_date	string	Data refresh task start date and time
task_end_date	string	Data refresh task end date and time

The groups object

Contains information about access groups for the campaign.

Parameter	Type	Description
id	int	User group ID
name	string	User group name