Get the list of suppression lists

Description

Retrieves multiple suppression lists information.

Request URL

Method: POST

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

Request parameters

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
format	string	"json"	No	Response data format By default – json
from_id	int	1	No	The first ID in the resulting list. By default – 1
limit	int	5	No	Suppression lists limit By default – 1000
ui_tags	[]String	[ "tag1", "tag2" ]	No	List of tags for search By default – []
groups	[]String	[ "group1", "group2" ]	No	List of access groups By default – []
groups_id	[]int	[ 0, 1 ]	No	List of access groups IDs By default – []

Request example

JSON

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

XML

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

Response example

JSON

    
{
    "data": [
        {
            "id": 1,
            "name": "Global suppress list",
            "ui_tags": [],
            "groups": [
                {
                    "id": 0,
                    "name": "main"
                }
            ]
        },
        {
            "id": 3,
            "name": "New suppression list",
            "ui_tags": [],
            "groups": [
                {
                    "id": 0,
                    "name": "main"
                }
            ]
        }
    ],
    "error": 0,
    "error_text": "Successful operation",
    "total_count": 5
}

XML

<xml>
    <data>
        <groups>
            <id>0</id>
            <name>"main"</name>
        </groups>
        <id>1</id>
        <name>"Global suppress list"</name>
        <ui_tags/>
    </data>
    <data>
        <groups>
            <id>0</id>
            <name>"main"</name>
        </groups>
        <id>3</id>
        <name>"New suppression list"</name>
        <ui_tags/>
    </data>
    <error>0</error>
    <error_text>Successful operation</error_text>
    <total_count>5</total_count>
</xml>

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text
id	int	Suppression list ID
name	string	Suppression list name
total_count	int	Total suppression lists count
ui_tags	[]String	List of tags
groups	[]String	List of groups