Get scenarios list

Description

Retrieves the list of all created scenarios.

Request URL

Method: POST

https://example.com/api/v1.1/resources/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 response By default – 1
limit	int	1	No	Resources list limit By default – 1000
groups	[]string	[ "group1", "group2" ]	No	List of access groups By default – []
groups_id	[]int	[ 0, 1 ]	No	List of access groups IDs By default – []
ui_tags	[]string	["tag1", "tag2"]	No	List of tags By default – []

Request example

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

Response example

{
    "data": [
        {
            "id": 15,
            "name": "Test scenario",
            "list_id": 1,
            "is_active": true,
            "ui_tags": [
                "tag1",
                "tag2"
            ],
            "mode": "skip_in_any_case",
            "groups": [
                {
                    "id": 1,
                    "name": "Test group"
                },
            ],
            "nodes": [
                {
                    "name": "Node 1",
                    "type": "campaign"
                },
                {
                    "name": "Node 2",
                    "type": "condition"
                },
                {
                    "name": "Node 3",
                    "type": "update"
                }
            ]
        }
    ],
    "error": 0,
    "error_text": "Successful operation",
    "total_count": 1
}

Response parameters

Parameter	Type	description
error	int	Error code
error_text	string	Error text
id	int	Resource ID
name	string	Resource name
list_id	int	Database ID
is_active	bool	Active or inactive scenario
mode	string	Mode if the profile is recaptured by the scenario
ui_tags	array	List of tags
groups	array of objects	List of groups
nodes	array of objects	List of nodes
total_count	int	Total resources count