Jump to Content
Kommo APITechnology Partnership
DocumentationRecipesAPI ReferenceChangelogDiscussions
Technology Partnership🇧🇷🇪🇸Community in DiscordKommo API
API Reference
🇧🇷🇪🇸Community in Discord
DocumentationRecipesAPI ReferenceChangelogDiscussions
All
Pages
Start typing to search…

API V4 GENERAL METHODS

  • Account
    • Account parametersget
  • OAuth 2.0
    • Get/renew an access tokenpost
  • Incoming leads
    • Incoming leads listget
    • Get an incoming lead by its UIDget
    • Add incoming leads from the type sip (call)post
    • Add incoming leads from the type formpost
    • Accept incoming leadspost
    • Decline incoming leadsdelete
    • Link incoming leadspost
    • Incoming leads summary informationget
    • Metadata objects description
  • Leads
    • Leads listget
    • Get a lead by its IDget
    • Add Leadspost
    • Update Leadspatch
    • Update a leadpatch
    • Complex addition of leads with contact and companypost
  • Leads pipelines and stages
    • Pipelines listget
    • Get a pipeline by its IDget
    • Add pipelinespost
    • Edit a pipelinepatch
    • Delete a pipelinedelete
    • Pipeline stages listget
    • Get a pipeline stage data by its IDget
    • Add stages to the pipelinepost
    • Pipeline stage editpatch
    • Delete a pipeline stagedelete
    • Available stage colors
  • Contacts
    • Contacts Listget
    • Get a contact by its IDget
    • Add contactspost
    • Update Contactspatch
    • Update a single contactpatch
  • Companies
    • Companies listget
    • Get a company by its IDget
    • Add companiespost
    • Update companiespatch
    • Update a companypatch
  • Lists
    • Get a list of listsget
    • Get a listget
    • Add listspost
    • Edit listspatch
    • Edit a listpatch
    • Get list elementsget
    • Get a list elementget
    • Add list elementspost
    • Edit list elementspatch
    • Edit a list elementpatch
  • Custom fields and field groups
    • Custom fields listget
    • Get an entity field by its IDget
    • Add custom fieldspost
    • Update custom fieldspatch
    • Update a custom fieldpatch
    • Custom fields list of a catalogget
    • Get a catalog field by its IDget
    • Add a custom field to a catalogpost
    • Update custom fields of a catalogpatch
    • Update a custom field of a catalogpatch
    • Delete a custom fielddelete
    • List of entity field groupsget
    • Get an entity field group by IDget
    • Add field groupspost
    • Edit a field grouppatch
    • Delete a field groupdelete
  • Users and roles
    • Users listget
    • Get user data by its IDget
    • Add userspost
    • User roles listget
    • Get a role data by its IDget
    • Add rolespost
    • Edit rolespatch
    • Delete a roledelete
  • Tasks
    • Tasks Listget
    • Get a task by its IDget
    • Add taskspost
    • Edit taskspatch
    • Edit a single taskpatch
  • Events
    • Events listget
    • Get an event by its IDget
    • Get events typesget
    • Events types
    • Events filtration
  • Notes
    • Get a particular entity’s notes list by the entity IDget
    • Notes list by the entity typeget
    • Get a note by its IDget
    • Add notespost
    • Edit notespatch
    • Edit a notepatch
    • Notes types
  • Tags
    • List of entity tagsget
    • Create tags for a particular entity typepost
    • Add tags to entitiespatch
    • Add tags to a single entitypatch
    • Tag colors
  • Links between entities
    • Linked entities listget
    • Link entitiespost
    • Unlink entitiespost
  • Salesbot
    • Launch Salesbotpost
    • SalesBot widget block execution confirmationpost
  • Sources
    • Get a list of sourcesget
    • Get a source by its IDget
    • Add sourcespost
    • Update a sourcepatch
    • Update sourcespatch
    • Delete a sourcedelete
    • Delete sourcesdelete
    • Get a list of Website chat button objectsget
    • Get a Website chat buttonget
    • Add Website chat buttonpost
    • Connect online chat to Website chat buttonpost
    • Update Website chat buttonpatch
  • Templates
    • Get a list of templatesget
    • Get a template by IDget
    • Add templatespost
    • Edit templatespatch
    • Submit a WhatsApp template for moderationpost
    • Edit a WhatsApp template statuspost
    • Delete templatesdelete
    • Delete a templatedelete
  • Webhooks
    • List of webhooksget
    • Add a webhookpost
    • Delete a webhookdelete
    • Webhook events
  • Widgets
    • Widgets Listget
    • Get the widget info by its codeget
    • Install the widget into the accountpost
    • Uninstall widgetdelete
  • Conversations
    • Get a conversation by IDget
    • Close a conversation by IDpost
  • Calls
    • Add call logpost

Files API

  • Files API capabilities
    • Files API Key Features
  • Files API methods
    • Getting started
    • Get a file by UUIDget
    • Get a list of filesget
    • Create a file upload sessionpost
    • Upload a part of the filepost
    • Edit a filepatch
    • Delete filesdelete
    • Restore filespost
    • Get a version of fileget
    • Get files attached to an entityget
    • Attach files to an entityput
    • Detach files from an entitydelete
    • Get entities associated with a fileget

Chats API

  • Five steps to send a message
    • Step 1: Register a new channel
    • Step 2: Connect chat channelpost
    • Step 3: Create new chatpost
    • Step 4: Link chat to contactpost
    • Step 5: Send, receive, or import messagespost
  • Get chat historyget
  • Get contact chatsget
  • Update message delivery statuspost
  • Transfer typing informationpost
  • Send or withdraw reactionspost
  • Disconnect chat channeldelete
  • Chats API account ID
  • Chats API authorization
  • Receiving Chat webhooks

Kommo AI API

  • Kommo AI key features
  • Kommo AI API methods
    • Add a source of the type URLpost
    • Add a source of the type filepost
    • Add a source of the type textpost
    • Launch import of products from CRM to AIpost

Other docs

  • Documentation
  • Recipes
Powered by 

Leads

In this section, we will describe all available methods for the Lead entity.

Leads list

Get a lead by its ID

Add Leads

Update Leads

Complex addition of leads with contact and company