get
https://{subdomain}.kommo.com/api/v4/bots/
The method allows to obtain a Salesbot by its ID
Limitations
The method is available for all account users.
"with" Parameters
| Parameter | Description |
|---|---|
| favorite | Adds is_favorite property to the response, which defines if the Salesbot is added to the favorites of the current account user. |
Data type header when the request is successful
Content-Type: application/hal+json
Data type header in case of an error
Content-Type: application/problem+json
Response parameters
| Parameter | Data type | Description |
|---|---|---|
| id | int | Salesbot ID |
| name | string | Salesbot name |
| is_visual_editor | bool | Defines the Salesbot editor type. true means the Salesbot is in the visual editor mode, false means the Salesbot is in the text (code) mode. |
| type_functionality | string | Salesbot functionality type: regular – a basic workflow Salesbot, greeting – welcome message bot, marketing – broadcasting messages, nps – survey. |
| settings | obj | Salesbot settings. |
| settings[active] | bool | Defines if the Salesbot is active. |
| is_favorite | bool | GET parameter with is required. Defines if the Salesbot is added to the favorites. |