Jump to Content
Technology Partnership
Documentation
Recipes
API Reference
Changelog
Technology Partnership
Join us in Discord
🇪🇸
🇧🇷
API Reference
Join us in Discord
🇪🇸
🇧🇷
API Reference
Events types
All
Pages
Start typing to search…
JUMP TO
API V4 GENERAL METHODS
About Kommo API
Account
Account parameters
get
OAuth 2.0
Get/renew an access token
post
Incoming leads
Incoming leads list
get
Get an incoming lead by its UID
get
Add incoming leads from the type sip (call)
post
Add incoming leads from the type form
post
Accept incoming leads
post
Decline incoming leads
del
Link incoming leads
post
Incoming leads summary information
get
Metadata objects description
Leads
Leads list
get
Get a lead by ID
get
Add leads
post
Update leads
patch
Update a lead
patch
Complex addition of leads with contact and company
post
Loss reasons list
get
Loss reason by ID
get
Leads pipelines and stages
Pipelines list
get
Get a pipeline by its ID
get
Add pipelines
post
Edit a pipeline
patch
Delete a pipeline
del
Pipeline stages list
get
Get a pipeline stage data by its ID
get
Add stages to the pipeline
post
Pipeline stage edit
patch
Delete a pipeline stage
del
Available stage colors
Contacts
Contacts list
get
Get a contact by ID
get
Add contacts
post
Update contacts
patch
Update a contact
patch
Companies
Companies list
get
Get a company by ID
get
Add companies
post
Update companies
patch
Update a company
patch
Lists
Get a list of lists
get
Get a list
get
Add lists
post
Edit lists
patch
Edit a list
patch
Get list elements
get
Get a list element
get
Add list elements
post
Edit list elements
patch
Edit a list element
patch
Custom fields and field groups
Custom fields list
get
Get an entity field by its ID
get
Add custom fields
post
Update custom fields
patch
Update a custom field
patch
Custom fields list of a catalog
get
Get a catalog field by its ID
get
Add a custom field to a catalog
post
Update custom fields of a catalog
patch
Update a custom field of a catalog
patch
Delete a custom field
del
List of entity field groups
get
Get an entity field group by ID
get
Add field groups
post
Edit a field group
patch
Delete a field group
del
Users and roles
Users list
get
Get user data by its ID
get
Add users
post
User roles list
get
Get a role data by its ID
get
Add roles
post
Edit roles
patch
Delete a role
del
Tasks
Tasks List
get
Get a task by its ID
get
Add tasks
post
Edit tasks
patch
Edit a single task
patch
Events
Events list
get
Get an event by its ID
get
Get events types
get
Events types
Events filtration
Notes
Get entity's notes list
get
Notes list by the entity type
get
Get a note by its ID
get
Add notes
post
Edit notes
patch
Edit a note
patch
Pin a note
post
Unpin a note
post
Notes types
Tags
List of entity tags
get
Create tags for a particular entity type
post
Add tags to entities
patch
Add tags to a single entity
patch
Tag colors
Links between entities
Linked entities list
get
Link entities
post
Unlink entities
post
Salesbot
Launch Salesbot
post
SalesBot widget block execution confirmation
post
Sources
Get a list of sources
get
Get a source by its ID
get
Add sources
post
Update a source
patch
Update sources
patch
Delete a source
del
Delete sources
del
Get a list of Website chat button objects
get
Get a Website chat button
get
Add Website chat button
post
Connect online chat to Website chat button
post
Update Website chat button
patch
Templates
Get a list of templates
get
Get a template by ID
get
Add templates
post
Edit templates
patch
Submit a WhatsApp template for moderation
post
Edit a WhatsApp template status
post
Delete templates
del
Delete a template
del
Webhooks
List of webhooks
get
Add a webhook
post
Delete a webhook
del
Webhook events
Widgets
Widgets List
get
Get the widget info by its code
get
Install the widget into the account
post
Uninstall widget
del
Conversations
Get a conversation by ID
get
Close a conversation by ID
post
Calls
Add call note
post
Add call notification
post
Files API
Files API capabilities
Files API Key Features
Files API methods
Getting started
Get a file by UUID
get
Get a list of files
get
Create a file upload session
post
Upload a part of the file
post
Edit a file
patch
Delete files
del
Restore files
post
Get a version of file
get
Get files attached to an entity
get
Attach files to an entity
put
Detach files from an entity
del
Get entities associated with a file
get
Chats API
Five steps to send a message
Register a chat channel
Chats API methods
Connect chat channel
post
Create new chat
post
Link chat to contact
post
Import, send and edit messages
post
Get chat history
get
Get contact chats
get
Update message delivery status
post
Transfer typing information
post
Send or withdraw reactions
post
Disconnect chat channel
del
Chats API account ID
Chats API authorization
Chats API webhooks
Kommo AI API
Kommo AI key features
Kommo AI API methods
Add a source of the type URL
post
Add a source of the type file
post
Add a source of the type text
post
Launch import of products from CRM to AI
post
Other docs
Documentation
Recipes
Powered by
Events types
Ask AI
Available event types
