KOkommo

Salesbots list

The method allows getting a list of Salesbots in the account

get/api/v4/bots

Request

  • Base URL
    https://subdomain.kommo.com
  • URL
    https://subdomain.kommo.com/api/v4/bots
  • Auth
    OAuth 2

Query parameters

pageinteger

A page of response

limitinteger

The number of entities returned per request (limit – 250)

filter[type_functionality][]string[]

Filter by Salesbot functionality type. Possible values: regular – a basic workflow Salesbot, greeting – a welcome message bot, marketing – a bot for broadcasting messages, nps – a bot for conducting NPS surveys

filter[id][]integer[]

Filter by Salesbot IDs

withstring

This parameter accepts a string which may consist of several values separated by commas

Response

Request is successfull

_total_itemsinteger
_pageinteger
_page_countinteger

Example response

{
  "_total_items": 1,
  "_page": 1,
  "_page_count": 1,
  "_links": {
    "self": {
      "href": "https://subdomain.kommo.com/api/v4/bots/?page=1&limit=250"
    }
  },
  "_embedded": {
    "items": [
      {
        "id": 250704,
        "name": "Salesbot #1",
        "type_functionality": "regular",
        "is_visual_editor": true,
        "settings": {
          "active": true
        },
        "_links": {
          "self": {
            "href": "https://subdomain.kommo.com/api/v4/bots/250704/?page=1&limit=250"
          }
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.