Get scenario information

Description

Get detailed information about an automation scenario.

Request URL

Method: GET, POST

https://example.com/api/v1.1/workflows/get

Request parameters

Parameter	Type	Example	Required	Description
id	int	1	Yes	Scenario identifier

Request example

JSON

{  
    "id": 1 
}

XML

<xml>
    <id>1</id>
</xml>

Response example

JSON

{
    "data": {
        "id": 10,
        "update_time": "2025-05-21T09:17:53.362Z",
        "name": "Welcome chain",
        "list_id": 1,
        "is_active": true,
        "high_priority": true,
        "ui_tags": [
            "B2C"
        ],
        "mode": "skip",
        "groups": [
            {
                "id": 2,
                "name": "Sales and promotion"
            }
        ],
        "attributes": {
            "season": "spring_2024",
            "branch": "marketing"
        },
        "nodes": [
            {
                "name": "DEFAULT_START_NODE_TITLE",
                "type": "start",
                "node_id": 0
            },
            {
                "templates": [
                    1
                ],
                "name": "Welcome letter",
                "type": "campaign",
                "node_id": 3,
                "campaign_id": 17
            },
            {
                "name": "1 d.0 h.0 m.",
                "type": "delay",
                "node_id": 4
            }
        ]
    },
    "error": 0,
    "error_text": "Successful operation"
}

XML

<xml>
    <data>
        <id>10</id>
        <update_time>2025-05-21T09:17:53.362Z</update_time>
        <name>Welcome chain</name>
        <list_id>1</list_id>
        <is_active>true</is_active>
        <high_priority>true</high_priority>
        <ui_tags>B2C</ui_tags>
        <mode>skip</mode>
        <groups>
            <id>2</id>
            <name>Sales and promotion</name>
        </groups>
        <attributes>
            <season>spring_2024</season>
            <branch>marketing</branch>
        </attributes>
        <nodes>
            <name>DEFAULT_START_NODE_TITLE</name>
            <type>start</type>
            <node_id>0</node_id>
        </nodes>
        <nodes>
            <name>Welcome letter</name>
            <type>campaign</type>
            <node_id>3</node_id>
            <campaign_id>17</campaign_id>
            <templates>1</templates>
        </nodes>
        <nodes>
            <name>1 d.0 h.0 m.</name>
            <type>delay</type>
            <node_id>4</node_id>
        </nodes>
    </data>
    <error>0</error>
    <error_text>Successful operation</error_text>
</xml>

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text
data object
id	int	Scenario identifier
name	string	Scenario name
list_id	int	Profile database identifier
is_active	bool	Whether the scenario is active
high_priority	bool	Whether the scenario is high-priority. Tasks of high-priority scenarios are processed by dedicated workers. See High-priority scenarios
mode	string	Mode when a profile enters the scenario more than once
ui_tags	array	List of tags
groups	array of objects	List of groups
attributes	object	Attributes assigned to the scenario and their values
nodes	array of objects	List of scenario elements
update_time	string	When the scenario was updated

The nodes object fields are described in the Get scenarios list article.