KOkommo

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

Página de resposta

limitinteger

Número de entidades retornadas por requisição (limite de 250)

filter[type_functionality][]string[]

Filtro pelo tipo de funcionalidade dos salesbots. Valores possíveis: regular – Fluxo básico de um salesbot, greeting – bot de boas-vindas, marketing – bot para a transmissão de mensagens, nps – bot para pesquisa de NPS.

filter[id][]integer[]

Filtro pelo ID do slalesbot

withstring

Esse parämetro aceita uma string que pode consistir de múltiplos valores separados por vírgula.

Response

Requisição bem-sucedida

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