Get mailing list

Description

Retrieves mailing list.

Request URL

Method: POST

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

Request parameters

Parameter	Type	Example	Required	Description
from_id	int	1	No	First mailing in the list ID. By default – 1
limit	int	2	No	Response mailings limit. By default – 1000
type	string	"trigger"	No	Mailing type
is_active	bool	true	No	Mailing active flag
ui_tags	[]String	[ "tag1", "tag2" ]	No	List of tags for search
groups	[]String	[ "group1", "group2" ]	No	List of access groups
groups_id	[]int	[ 0, 1 ]	No	List of access groups IDs
attributes	object	{"season": {"options": ["spring_2024", "summer_2024"]}}	No	Attributes and their values for search
message_id	int	42	No	Message template ID for filtering mailings. Only mailings using the specified template are returned

Request example

JSON

{
  "limit": 2
}

XML

<xml>
  <limit>2</limit>
</xml>

Response example

JSON

{
    "data": [
        {
            "id": 5,
            "name": "New meteoric mailing",
            "type": "broadcast",
            "is_active": false,
            "subid": "",
            "for_confirm": false,
            "ui_tags": [],
            "groups": [
                {
                    "id": 0,
                    "name": "main"
                }
            ],
            "attributes": {
                "season": "spring_2024",
                "branch": "marketing"
            },
            "content": [
                {
                    "subject": "Promo email",
                    "from_email": "promo@example.com",
                    "from_name": "Promo Team",
                    "replyto_email": "support@example.com",
                    "replyto_name": "Support",
                    "message_id": 42,
                    "message_name": "Spring Promo Template"
                }
            ],
            "data_type": "segment",
            "updatetime": "2026-07-22T12:00:00Z",
            "updated_user": "john.doe"
        },
        {
            "id": 7,
            "name": "Copy of New meteoric mailing",
            "type": "trigger",
            "is_active": true,
            "subid": "",
            "for_confirm": false,
            "ui_tags": [],
            "groups": [
                {
                    "id": 0,
                    "name": "main"
                }
            ],
            "providers": [
                "google",
                "mozilla",
                "safari",
                "safari-native",
                "firefox-firebase",
                "chrome-firebase",
                "opera-firebase",
                "yandex-firebase",
                "samsung-firebase",
                "android-firebase",
                "ios-firebase",
                "ios-apns"
            ],
            "content": [
                {
                    "message_id": 15,
                    "message_name": "Push Notification"
                }
            ],
            "data_type": "trigger",
            "updatetime": "2026-07-22T13:00:00Z",
            "updated_user": "jane.smith"
        }
    ],
    "error": 0,
    "error_text": "Successful operation",
    "next_from_id": 8,
    "total_count": 134
}

XML

<xml>
    <error>0</error>
    <error_text>Successful operation</error_text>
    <data>
        <id>5</id>
        <name>New meteoric mailing</name>
        <type>broadcast</type>
        <is_active>false</is_active>
        <subid></subid>
        <for_confirm>false</for_confirm>
        <groups>
            <id>0</id>
            <name>main</name>
        </groups>
        <attributes>
            <season>spring_2024</season>
            <branch>marketing</branch>
        </attributes>
        <content>
            <subject>Promo email</subject>
            <from_email>promo@example.com</from_email>
            <from_name>Promo Team</from_name>
            <replyto_email>support@example.com</replyto_email>
            <replyto_name>Support</replyto_name>
            <message_id>42</message_id>
            <message_name>Spring Promo Template</message_name>
        </content>
        <data_type>segment</data_type>
        <updatetime>2026-07-22T12:00:00Z</updatetime>
        <updated_user>john.doe</updated_user>
    </data>
    <data>
        <id>7</id>
        <name>Copy of New meteoric mailing</name>
        <type>trigger</type>
        <is_active>true</is_active>
        <subid></subid>
        <for_confirm>false</for_confirm>
        <groups>
            <id>0</id>
            <name>main</name>
        </groups>
        <providers>
            <provider>google</provider>
            <provider>mozilla</provider>
            <provider>safari</provider>
            <provider>ios-apns</provider>
        </providers>
        <content>
            <message_id>15</message_id>
            <message_name>Push Notification</message_name>
        </content>
        <data_type>trigger</data_type>
        <updatetime>2026-07-22T13:00:00Z</updatetime>
        <updated_user>jane.smith</updated_user>
    </data>
    <next_from_id>8</next_from_id>
    <total_count>134</total_count>
</xml>

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text
next_from_id	int	Value to pass as from_id in the next request for pagination. Continue until the data array is empty
id	int	Mailing ID
is_active	bool	Mailing active flag
name	string	Mailing name
type	string	Mailing type
total_count	int	Total mailing count
for_confirm	bool	Mailings with confirmation link flag
ui_tags	[]String	List of tags
groups	[]object	List of access groups (objects with id and name fields)
subid	string	Mailing SubID
attributes	object	Attributes assigned to the mailing and their values
scampaign_id	int	Campaign ID in which the mailing is engaged (The parameter is returned if the mailing is engaged in a campaign)
content	[]object	Mailing content array (message templates)
content[].message_id	int	Message template ID
content[].message_name	string	Message template name
content[].subject	string	Email subject (email mailings only; falls back to the template value if not set in the mailing)
content[].from_email	string	Sender email (email mailings only; falls back to the template value if not set in the mailing)
content[].from_name	string	Sender name (email mailings only; falls back to the template value if not set in the mailing)
content[].replyto_email	string	Reply-to email (email mailings only; falls back to the template value if not set in the mailing)
content[].replyto_name	string	Reply-to name (email mailings only; falls back to the template value if not set in the mailing)
data_type	string	Audience source type for the mailing Possible values: segment — segment, list — list, trigger — trigger mailing, "" — mailing without segment
updatetime	string	Last mailing update time (RFC 3339)
updated_user	string	Login of the user who last updated the mailing
providers	[]string	List of push notification providers (Returned only for push mailings)