GET /api/v4/bots

Request

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

Query parameters

pageinteger

Página de la respuesta

limitinteger

Cantidad de entidades devueltas por solicitud (límite: 250)

filter[type_functionality][]string[]

Filtrar por tipo de funcionalidad del Salesbot. Valores posibles: regular – Salesbot de flujo básico, greeting – bot de mensaje de bienvenida, marketing – bot para envío de mensajes de difusión, nps – bot para realizar encuestas NPS

filter[id][]integer[]

Filtrar por IDs de Salesbots

withstring

Este parámetro acepta una cadena que puede contener varios valores (consulte la tabla anterior) separados por comas.

Response

Solicitud exitosa

_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.