For AI agents: visit https://developers.kommo.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Kommo APITechnology Partnership
DocumentationRecipesAPI ReferenceChangelog
Technology PartnershipJoin us in Discord🇪🇸🇧🇷Kommo API
API Reference
Join us in Discord🇪🇸🇧🇷

API V4 GENERAL METHODS

  • About Kommo API
  • Account
    • Account parametersget
  • OAuth 2.0
    • Get/refresh access tokenpost
  • Incoming leads
    • Incoming leads listget
    • Get incoming lead by UIDget
    • Add incoming leads from the type sip (call)post
    • Add incoming leads from the type formpost
    • Accept incoming leadspost
    • Decline incoming leadsdel
    • Link incoming leadspost
    • Incoming leads summary informationget
    • Metadata objects description
  • Leads
    • Get leadsget
    • Get lead by IDget
    • Add leadspost
    • Update leadspatch
    • Update leadpatch
    • Complex addition of leads with contact and companypost
    • Loss reasons listget
    • Loss reason by IDget
  • Leads pipelines and stages
    • Get pipelinesget
    • Get pipeline by IDget
    • Add pipelinespost
    • Edit pipelinepatch
    • Delete pipelinedel
    • Pipeline stages listget
    • Get pipeline stage by IDget
    • Add stages to pipelinepost
    • Pipeline stage editpatch
    • Delete pipeline stagedel
    • Available stage colors
  • Contacts
    • Contacts listget
    • Get contact by IDget
    • Add contactspost
    • Update contactspatch
    • Update contactpatch
  • Companies
    • Companies listget
    • Get company by IDget
    • Add companiespost
    • Update companiespatch
    • Update companypatch
  • Lists
    • Get listsget
    • Get listget
    • Add listspost
    • Edit listspatch
    • Edit listpatch
    • Get list elementsget
    • Get list elementget
    • Add list elementspost
    • Edit list elementspatch
    • Edit list elementpatch
  • Custom fields and field groups
    • Custom fields listget
    • Get entity field by IDget
    • Add custom fieldspost
    • Update custom fieldspatch
    • Update 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 fielddel
    • List of entity field groupsget
    • Get an entity field group by IDget
    • Add field groupspost
    • Edit a field grouppatch
    • Delete a field groupdel
  • Users and roles
    • Users listget
    • Get user by IDget
    • Add userspost
    • Activate userspost
    • Deactivate userspost
    • User roles listget
    • Get role by IDget
    • Add rolespost
    • Edit rolespatch
    • Delete roledel
  • Tasks
    • Tasks listget
    • Get task by IDget
    • Add taskspost
    • Edit taskpatch
    • Edit taskspatch
  • Events
    • Events listget
    • Get event by IDget
    • Get events typesget
    • Events types
    • Events filtration
  • Notes
    • Get notes list of entityget
    • Get notes list by entity typeget
    • Get note by IDget
    • Add notespost
    • Edit notespatch
    • Edit notepatch
    • Pin notepost
    • Unpin notepost
    • 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
    • Salesbots listget
    • Get a Salesbot by IDget
    • Launch Salesbotpost
    • Launch Salesbotspost
    • Stop a Salesbotpost
    • SalesBot widget block execution confirmationpost
  • Sources
    • Get sourcesget
    • Get source by IDget
    • Add sourcespost
    • Update sourcepatch
    • Update sourcespatch
    • Delete sourcedel
    • Delete sourcesdel
    • Get list of Website chat buttonsget
    • Get Website chat buttonget
    • Add Website chat buttonpost
    • Connect online chat to Website chat buttonpost
    • Update Website chat buttonpatch
  • Templates
    • Get list of templatesget
    • Get template by IDget
    • Add templatespost
    • Edit templatespatch
    • Submit a WhatsApp template for moderationpost
    • Edit a WhatsApp template statuspost
    • Delete templatesdel
    • Delete a templatedel
  • Webhooks
    • List of webhooksget
    • Add webhookpost
    • Delete webhookdel
    • Webhook events
  • Widgets
    • Widgets Listget
    • Get the widget info by its codeget
    • Install widget into accountpost
    • Uninstall widgetdel
  • Conversations
    • Get conversationsget
    • Get conversation by IDget
    • Close conversationpost
  • Calls
    • Add call notepost
    • Add call notificationpost

Files API

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

Chats API

  • Five steps to send a message
  • Register a chat channel
  • Chats API methods
    • Connect chat channelpost
    • Create new chatpost
    • Link chat to contactpost
    • Import, send and edit messagespost
    • Get chat historyget
    • Get contact chatsget
    • Update message delivery statuspost
    • Transfer typing informationpost
    • Send or withdraw reactionspost
    • Disconnect chat channeldel
  • Chats API account ID
  • Chats API authorization
  • Chats API webhooks
  • Chats API add-on
    • Get conversation messagesget
    • Send message to conversationpost

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

Updated about 1 year ago


Metadata objects description
Get leads
Did this page help you?

Updated about 1 year ago


Metadata objects description
Get leads
Did this page help you?