Jump to Content
Kommo API
DocumentationRecipesAPI ReferenceChangelogDiscussions
🇧🇷🇪🇸Community in DiscordKommo API
API Reference
🇧🇷🇪🇸Community in Discord
DocumentationRecipesAPI ReferenceChangelogDiscussions

API V4 GENERAL METHODS

  • Account
    • Account parametersget
  • OAuth 2.0
    • Get/renew an access tokenpost
  • Incoming leads
    • Incoming leads listget
    • Getting an incoming lead by its UIDget
    • Adding incoming leads from the type sip (call)post
    • Adding incoming leads from the type formpost
    • Accepting incoming leadspost
    • Declining incoming leadsdelete
    • Linking incoming leadspost
    • Incoming leads summary informationget
    • Metadata objects description
  • Leads
    • Leads listget
    • Getting a lead by its IDget
    • Adding Leadspost
    • Updating Leadspatch
    • Updating a leadpatch
    • Complex addition of leads with contact and companypost
  • Leads pipelines and stages
    • Pipelines listget
    • Getting a pipeline by its IDget
    • Adding pipelinespost
    • Editing a pipelinepatch
    • Deleting a pipelinedelete
    • Pipeline stages listget
    • Getting a pipeline stage data by its IDget
    • Adding stages to the pipelinepost
    • Pipeline stage editpatch
    • Deleting a pipeline stagedelete
    • Available stage colors
  • Contacts
    • Contacts Listget
    • Getting a contact by its IDget
    • Adding contactspost
    • Updating Contactspatch
    • Updating a single contactpatch
  • Companies
    • Companies listget
    • Getting a company by its IDget
    • Add companiespost
    • Updating companiespatch
    • Updating a companypatch
  • Lists
    • Get a list of listsget
    • Get a listget
    • Adding listspost
    • Editing listspatch
    • Editing a listpatch
    • Get list elementsget
    • Get a list elementget
    • Adding list elementspost
    • Editing list elementspatch
    • Editing a list elementpatch
  • Custom fields
    • Custom fields listget
    • Custom fields list of a listget
    • Getting an entity field by its IDget
    • Getting a list field by its IDget
    • Adding custom fieldspost
    • Adding a custom field to a listpost
    • Updating custom fieldspatch
    • Updating a custom fieldpatch
    • Updating custom fields of a listpatch
    • Updating a custom field of a listpatch
    • Deleting a custom fielddelete
  • Users and roles
    • Users listget
    • Getting user data by its IDget
    • Adding userspost
    • User roles listget
    • Getting a role data by its IDget
    • Adding rolespost
    • Editing rolespatch
    • Deleting a roledelete
  • Tasks
    • Tasks Listget
    • Getting a task by its IDget
    • Adding taskspost
    • Editing taskspatch
    • Editing a single taskpatch
  • Events
    • Events listget
    • Getting an event by its IDget
    • Getting events typesget
    • Events types
    • Events filtration
  • Notes
    • Getting a particular entity’s notes list by the entity IDget
    • Notes list by the entity typeget
    • Get a note by its IDget
    • Adding notespost
    • Editing notespatch
    • Editing a notepatch
    • Notes types
  • Tags
    • List of entity tagsget
    • Creating tags for a particular entity typepost
    • Adding tags to entitiespatch
    • Adding tags to a single entitypatch
    • Tag colors
  • Links between entities
    • Linked entities listget
    • Linking entitiespost
    • Unlinking 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
  • 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
    • Adding a webhookpost
    • Deleting a webhookdelete
    • Webhook events
  • Widgets
    • Widgets Listget
    • Getting the widget info by its codeget
    • Installing the widget into the accountpost
    • Uninstalling widgetdelete
  • Conversations
    • Get a conversation by IDget
    • Close a conversation by IDpost
  • Calls
    • Add callspost

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
  • Chat API account ID
  • 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

Getting a lead by its ID

Adding Leads

Updating Leads

Complex addition of leads with contact and company