Kommo Widgets API
The Widgets API from Kommo — 2 operation(s) for widgets.
The Widgets API from Kommo — 2 operation(s) for widgets.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/kommo:kommo-widgets-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Kommo Widgets API
version: '1.0'
description: 'Operations tagged Widgets across 2 of this provider''s published API definitions: kommo-api-openapi.yml, kommo-api-references-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{subdominio}.kommo.com
variables:
subdominio:
default: subdominio
- url: https://{subdomain}.kommo.com
variables:
subdomain:
default: subdomain
security:
- sec0: []
tags:
- name: Widgets
paths:
/api/v4/widgets:
get:
summary: Lista de widgets
description: Este método retorna una lista agregada de los widgets públicos instalados en la cuenta, así como los widgets añadidos por el usuario actual.
operationId: lista-de-widgets
parameters:
- name: page
in: query
description: Página de la respuesta
schema:
type: integer
format: int32
- name: limit
in: query
description: 'Cantidad de elementos retornados en la respuesta de una solicitud (límite: 250)'
schema:
type: integer
format: int32
responses:
'200':
description: '200'
content:
application/json:
examples:
Solicitud exitosa:
value: "{\n \"_page\": 1,\n \"_links\": {\n \"self\": {\n \"href\": \"https://example.kommo.com/api/v4/widgets?limit=2&page=1\"\n },\n \"next\": {\n \"href\": \"https://example.kommo.com/api/v4/widgets?limit=2&page=2\"\n }\n },\n \"_embedded\": {\n \"widgets\": [\n {\n \"id\": 333XXX,\n \"code\": \"facebook\",\n \"version\": \"0.0.13\",\n \"rating\": \"2,8\",\n \"settings_template\": [\n {\n \"key\": \"fb\",\n \"name\": \"custom\",\n \"type\": \"custom\",\n \"is_required\": false\n }\n ],\n \"is_lead_source\": false,\n \"is_work_with_dp\": false,\n \"is_crm_template\": false,\n \"client_uuid\": null,\n \"is_active_in_account\": false,\n \"pipeline_id\": null,\n \"_links\": {\n \"self\": {\n \"href\": \"https://example.kommo.com/api/v4/widgets/facebook\"\n }\n }\n },\n {\n \"id\": 000XYZ,\n \"code\": \"wechat\",\n \"version\": \"1.1.12\",\n \"rating\": \"3,4\",\n \"settings_template\": [\n {\n \"key\": \"wechat\",\n \"name\": \"custom\",\n \"type\": \"custom\",\n \"is_required\": false\n }\n ],\n \"is_lead_source\": false,\n \"is_work_with_dp\": false,\n \"is_crm_template\": false,\n \"client_uuid\": null,\n \"is_active_in_account\": false,\n \"pipeline_id\": null,\n \"_links\": {\n \"self\": {\n \"href\": \"https://example.kommo.com/api/v4/widgets/wechat\"\n }\n }\n }\n ]\n }\n}"
'401':
description: '401'
content:
application/json:
examples:
El usuario no está autorizado:
value: "{\n \"title\": \"Unauthorized\",\n \"type\": \"https://httpstatus.es/401\",\n \"status\": 401,\n \"detail\": \"Nombre de usuario o contraseña incorrectos\"\n}"
schema:
type: object
properties:
title:
type: string
example: Unauthorized
type:
type: string
example: https://httpstatus.es/401
status:
type: integer
example: 401
default: 0
detail:
type: string
example: Nombre de usuario o contraseña incorrectos
deprecated: false
tags:
- Widgets
servers:
- url: https://{subdominio}.kommo.com
variables:
subdominio:
default: subdominio
/api/v4/widgets/{widget_code}:
post:
summary: Instalar el widget en la cuenta
description: Este método permite instalar el widget en la cuenta.
operationId: instalar-widget-en-cuenta
parameters:
- name: widget_code
in: query
description: Código del widget
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
RAW_BODY:
type: string
format: json
responses:
'200':
description: '200'
content:
application/json:
examples:
Widget instalado con éxito:
value: "{\n \"id\": 123XXX,\n \"code\": \"asterisk\",\n \"version\": \"1.1.6\",\n \"rating\": \"0\",\n \"settings_template\": [\n {\n \"key\": \"login\",\n \"name\": \"Usuario\",\n \"type\": \"text\",\n \"is_required\": true\n },\n {\n \"key\": \"password\",\n \"name\": \"Contraseña\",\n \"type\": \"pass\",\n \"is_required\": true\n },\n {\n \"key\": \"phones\",\n \"name\": \"Números de teléfono\",\n \"type\": \"users\",\n \"is_required\": true\n },\n {\n \"key\": \"script_path\",\n \"name\": \"Ruta del script\",\n \"type\": \"text\",\n \"is_required\": true\n }\n ],\n \"is_lead_source\": false,\n \"is_work_with_dp\": false,\n \"is_crm_template\": false,\n \"client_uuid\": null,\n \"is_active_in_account\": true,\n \"pipeline_id\": null,\n \"settings\": {\n \"login\": \"dww123\",\n \"password\": \"sdaw13213\",\n \"phones\": {\n \"504141\": \"1039\"\n },\n \"script_path\": \"https://example.com/\"\n },\n \"_links\": {\n \"self\": {\n \"href\": \"https://subdomain.kommo.com/api/v4/widgets/asterisk\"\n }\n }\n}"
'400':
description: '400'
content:
application/json:
examples:
Datos transmitidos inválidos. Detalles disponibles en la respuesta:
value: '{}'
schema:
type: object
properties: {}
'401':
description: '401'
content:
application/json:
examples:
El usuario no está autorizado:
value: "{\n \"title\": \"Unauthorized\",\n \"type\": \"https://httpstatus.es/401\",\n \"status\": 401,\n \"detail\": \"Nombre de usuario o contraseña incorrectos\"\n}"
schema:
type: object
properties:
title:
type: string
example: Unauthorized
type:
type: string
example: https://httpstatus.es/401
status:
type: integer
example: 401
default: 0
detail:
type: string
example: Nombre de usuario o contraseña incorrectos
'404':
description: '404'
content:
application/json:
examples:
No se encontró el widget:
value: '{}'
schema:
type: object
properties: {}
deprecated: false
tags:
- Widgets
delete:
summary: Desinstalar el widget
description: Este método permite desinstalar un widget por su código.
operationId: desinstalar-el-widget
parameters:
- name: widget_code
in: query
description: Código del widget
schema:
type: string
- name: Content-Type
in: header
description: Encabezado de la solicitud
schema:
type: string
default: application/json
responses:
'200':
description: '200'
content:
application/json:
examples:
Widget instalado con éxito:
value: '{}'
schema:
type: object
properties: {}
'401':
description: '401'
content:
application/json:
examples:
El usuario no esta autorizado:
value: "{\n \"title\": \"Unauthorized\",\n \"type\": \"https://httpstatus.es/401\",\n \"status\": 401,\n \"detail\": \"Nombre de usuario o contraseña incorrectos\"\n}"
schema:
type: object
properties:
title:
type: string
example: Unauthorized
type:
type: string
example: https://httpstatus.es/401
status:
type: integer
example: 401
default: 0
detail:
type: string
example: Nombre de usuario o contraseña incorrectos
'403':
description: '403'
content:
application/json:
examples:
Derechos insuficientes para llamar a este método:
value: '{}'
schema:
type: object
properties: {}
'404':
description: '404'
content:
application/json:
examples:
No se encontró el widget:
value: '{}'
schema:
type: object
properties: {}
deprecated: false
tags:
- Widgets
get:
summary: Getting the widget info by its code
description: This method allows getting the information on a public widget or a private widget uploaded by the current user.
operationId: widget-by-code
parameters:
- name: widget_code
in: path
description: Widget code
schema:
type: string
required: true
responses:
'200':
description: '200'
content:
application/json:
examples:
Request successful:
value: "{\n \"id\": 1234567,\n \"code\": \"birthday\",\n \"version\": \"0.0.13\",\n \"rating\": \"0\",\n \"settings_template\": [\n {\n \"key\": \"bd\",\n \"name\": \"custom\",\n \"type\": \"custom\",\n \"is_required\": false\n }\n ],\n \"is_lead_source\": false,\n \"is_work_with_dp\": false,\n \"is_crm_template\": false,\n \"client_uuid\": null,\n \"is_active_in_account\": false,\n \"pipeline_id\": null,\n \"_links\": {\n \"self\": {\n \"href\": \"https://subdomain.kommo.com/api/v4/widgets/birthday\"\n }\n }\n}"
schema:
type: object
properties:
id:
type: integer
example: 1234567
default: 0
code:
type: string
example: birthday
version:
type: string
example: 0.0.13
rating:
type: string
example: '0'
settings_template:
type: array
items:
type: object
properties:
key:
type: string
example: bd
name:
type: string
example: custom
type:
type: string
example: custom
is_required:
type: boolean
example: false
default: true
is_lead_source:
type: boolean
example: false
default: true
is_work_with_dp:
type: boolean
example: false
default: true
is_crm_template:
type: boolean
example: false
default: true
client_uuid: {}
is_active_in_account:
type: boolean
example: false
default: true
pipeline_id: {}
_links:
type: object
properties:
self:
type: object
properties:
href:
type: string
example: https://subdomain.kommo.com/api/v4/widgets/birthday
'401':
description: '401'
content:
application/json:
examples:
User is not authorized:
value: '{}'
schema:
type: object
properties: {}
'404':
description: '404'
content:
text/plain:
examples:
Widget isn’t found or is unavailable:
value: ''
deprecated: false
tags:
- Widgets
servers:
- url: https://{subdominio}.kommo.com
variables:
subdominio:
default: subdominio
components:
securitySchemes:
sec0:
type: oauth2
flows: {}
x-refined-from:
- kommo-api-openapi.yml
- kommo-api-references-api-openapi.yml
x-readme-fauxas: true
x-provenance:
method: searched
source: https://developers.kommo.com/reference
harvested: '2026-11-15'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://developers.kommo.com/reference/ai-add-source-file.md
- https://developers.kommo.com/reference/ai-add-source-text.md
- https://developers.kommo.com/reference/ai-add-source-url.md
- https://developers.kommo.com/reference/launch-import-of-products-from-crm-to-ai.md
- https://pt-developers.kommo.com/reference/ai-add-source-file.md
- https://pt-developers.kommo.com/reference/ai-add-source-text.md
- https://pt-developers.kommo.com/reference/ai-add-source-url.md
- https://pt-developers.kommo.com/reference/launch-import-of-products-from-crm-to-ai.md
merge:
pages: 8
deduped: 7
conflicts_kept_first: 4