Kommo
Gestão de leads, contatos, empresas, pipelines, tarefas, notas, catálogos, usuários, webhooks e integrações via API v4.
Authentication
This connector uses Token-based authentication.
info
Set up your connection in the Abstra Console before using it in your workflows.
How to use
Using the Smart Chat
Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".
Using the Web Editor
from abstra.connectors import run_connection_action
result = run_connection_action(
connection_name="your_connection_name",
action_name="your_action_name",
params={
"param1": "value1",
"param2": "value2"
})
Available Actions
This connector provides 145 actions:
| Action | Purpose | Parameters |
|---|---|---|
| post_oauth2_access_token | The method allows you to exchange an authorization code to access token and refresh token | data: { . client_id (string) . client_secret (string) . grant_type (string) . code (string) . refresh_token (string) . redirect_uri (string) } (object) required |
| get_api_v4_leads_unsorted | This method allows getting a list of the incoming leads in the account | page (integer) limit (integer) filteruid (array) filtercategory (array) filterpipeline_id (integer) ordercreated_at (string) |
| get_api_v4_leads_unsorted_by_uid | This method allows getting a particular incoming lead data by its UID | uid (string) |
| post_api_v4_leads_unsorted_sip | This method allows adding single or multiple incoming leads into the account | data: { . RAW_BODY (array) } (object) required |
| post_api_v4_leads_unsorted_forms | This method allows adding multiple or singular incoming leads | data: { . RAW_BODY (array) } (object) required |
| post_api_v4_leads_unsorted_by_uid_accept | This method allows accept an incoming lead. | uid (string) data: { . user_id (integer) . status_id (integer) } (object) required |
| delete_api_v4_leads_unsorted_by_uid_decline | This method allows declining an incoming lead | uid (string) data: { . user_id (integer) } (object) required |
| post_api_v4_leads_unsorted_by_uid_link | This method allows linking an incoming lead to an existing lead. | uid (string) data: { . link (object) . user_id (integer) } (object) required |
| get_api_v4_leads_unsorted_summary | This method allows getting summary information about the incoming leads. | filteruid (array) filtercreated_at (integer) filtercreated_atfrom (integer) filtercreated_atto (integer) filterpipeline_id (integer) |
| get_api_v4_leads | This method allows getting a list of leads in the account | with (string) page (integer) limit (string) query (string) ordercreated_at (string) orderupdated_at (string) orderid (string) filterid (array) filtername (array) filterprice (integer) filtercreated_by (array) filterupdated_by (array) filterresponsible_user_id (array) filtercreated_atfrom (integer) filtercreated_atto (integer) filterupdated_atfrom (integer) filterupdated_atto (integer) filterclosed_atfrom (integer) filterclosed_atto (integer) filterclosest_task_atfrom (integer) filterclosest_task_atto (integer) filterpipeline_id (array) filterstatuses0pipeline_id (integer) filterstatuses0status_id (integer) |
| post_api_v4_leads | This method allows adding multiple or singular leads into the account. | data: { . RAW_BODY (array) } (object) required |
| patch_api_v4_leads | This method allows updating multiple leads. When updating multiple leads, an array of lead objects is passed. | data: { . RAW_BODY (array) } (object) required |
| get_api_v4_leads_by_id | This method allows getting a particular lead data by its ID. | id (integer) with (string) |
| patch_api_v4_leads_by_id | This method allows updating a single lead. Pass an object to update a single lead. | id (integer) data: { . name (string) . price (number) . status_id (integer) . pipeline_id (integer) . created_by (integer) . updated_by (integer) . created_at (integer) . updated_at (integer) . closed_at (integer) . loss_reason_id (integer) . responsible_user_id (integer) . custom_fields_values (string) . _embedded (object) . request_id (string) . tags_to_add (array) . tags_to_delete (array) } (object) required |
| post_api_v4_leads_complex | The method allows you to add leads with contacts and a company to your account in batches. The added data can be checked in the duplicate control. | data: { . RAW_BODY (array) } (object) required |
| post_api_v4_leads_pipelines | This method allows adding multiple pipelines | data: { . RAW_BODY (array) } (object) required |
| get_api_v4_leads_pipelines | The method allows to get a list of pipelines on the account. | No parameters |
| get_api_v4_leads_pipelines_by_id | This method allows getting a single pipeline object by its ID. | id (integer) |
| patch_api_v4_leads_pipelines_by_id | This method allows editing the pipeline on the account | id (integer) data: { . name (string) . sort (integer) . is_main (boolean) . is_unsorted_on (boolean) } (object) required |
| delete_api_v4_leads_pipelines_by_id | This method allows to delete a pipeline from the account | id (integer) |
| get_api_v4_leads_pipelines_by_pipeline_id_statuses | This method allows to get a list of pipeline stages on the account. | pipeline_id (integer) with (string) |
| post_api_v4_leads_pipelines_by_pipeline_id_statuses | This method allows adding multiple stages. You can pass stage descriptions optional. | pipeline_id (integer) data: { . RAW_BODY (array) } (object) required |
| get_api_v4_leads_pipelines_by_pipeline_id_statuses_by_id | This method allows to get a pipeline stage object by its ID | pipeline_id (integer) id (integer) with (string) |
| patch_api_v4_leads_pipelines_by_pipeline_id_statuses_by_id | This method allows editing a pipeline stage. You can pass stage descriptions optional. | pipeline_id (integer) id (integer) data: { . name (string) . sort (integer) . color (string) . descriptions (array) } (object) required |
| delete_api_v4_leads_pipelines_by_pipeline_id_statuses_by_id | This method allows deleting a stage | pipeline_id (integer) id (integer) |
| get_api_v4_contacts | This method allows to get a list of contacts in the account | with (string) page (integer) limit (integer) query (string) orderupdated_at (string) orderid (string) filterid (array) filtername (array) filtercreated_by (array) filterupdated_by (array) filterresponsible_user_id (array) filterupdated_atfrom (integer) filterupdated_atto (integer) filterclosest_task_atfrom (integer) filterclosest_task_atto (integer) |
| post_api_v4_contacts | This method allows adding multiple or singular contacts into the account | data: { . RAW_BODY (array) } (object) required |
| patch_api_v4_contacts | This method allows updating multiple contacts. When updating multiple contacts, an array of contact objects is passed. | data: { . RAW_BODY (array) } (object) required |
| get_api_v4_contacts_by_id | This method allows to get a particular contact data by its ID | id (integer) with (string) |
| patch_api_v4_contacts_by_id | This method allows updating a contact. The contact object is passed. | id (integer) data: { . RAW_BODY (object) } (object) required |
| get_api_v4_companies | The method allows you to get a list of companies | with (string) page (integer) limit (integer) query (string) orderupdated_at (string) orderid (string) filterid (array) filtername (array) filtercreated_by (array) filterupdated_by (array) filterresponsible_user_id (array) filtercreated_atfrom (integer) filtercreated_atto (integer) filterupdated_atfrom (integer) filterupdated_atto (integer) filterclosest_task_atfrom (integer) filterclosest_task_atto (integer) |
| post_api_v4_companies | This method allows adding one or more companies into the account | data: { . RAW_BODY (array) } (object) required |
| patch_api_v4_companies | This method allows updating multiple companies. An array of objects is passed. | data: { . RAW_BODY (array) } (object) required |
| get_api_v4_companies_by_id | This method allows to get a particular company data by its ID | id (integer) with (string) |
| patch_api_v4_companies_by_id | This method allows updating a singular company an object is passed | id (integer) data: { . RAW_BODY (object) } (object) required |
| get_api_v4_catalogs | The method allows getting a list of available lists. | page (integer) limit (integer) |
| post_api_v4_catalogs | The method allows adding multiple lists | data: { . RAW_BODY (array) } (object) required |
| patch_api_v4_catalogs | This method allows editing multiple lists. An array of list objects is passed. | data: { . RAW_BODY (array) } (object) required |
| patch_api_v4_catalogs_by_id | This method allows editing a singular list. The list object is passed. | id (integer) data: { . RAW_BODY (object) } (object) required |
| get_api_v4_catalogs_by_id | The method allows getting a particular list of data by its ID. | id (integer) |
| get_api_v4_catalogs_by_list_id_elements | This method allows getting available list elements. | list_id (integer) page (integer) limit (integer) query (string) filterid (array) |
| post_api_v4_catalogs_by_list_id_elements | This method allows adding multiple list elements | list_id (integer) data: { . RAW_BODY (array) } (object) required |
| patch_api_v4_catalogs_by_list_id_elements | This method allows editing multiple list elements. An array of element objects is passed. | list_id (integer) data: { . RAW_BODY (array) } (object) required |
| get_api_v4_catalogs_by_list_id_elements_by_element_id | This method allows to get a list element data by its ID | list_id (integer) element_id (integer) |
| patch_api_v4_catalogs_by_list_id_elements_by_element_id | This method allows editing multiple list elements. An object is passed. | list_id (integer) element_id (integer) data: { . RAW_BODY (object) } (object) required |
| get_api_v4_by_entity_type_custom_fields | This method allows to get a list of custom fields in the account leads, companies, contacts | entity_type (string) page (integer) limit (integer) ordersort (string) orderid (string) filtertype0 (string) |
| post_api_v4_by_entity_type_custom_fields | This method allows to add singular or multiple custom fields to an entityleads, companies, contacts | entity_type (string) data: { . RAW_BODY (array) } (object) required |
| patch_api_v4_by_entity_type_custom_fields | This method allows updating multiple custom fields of an entity leads/contacts/companies | entity_type (string) data: { . RAW_BODY (array) } (object) required |
| get_api_v4_catalogs_by_list_id_custom_fields | This method allows to get a list of list custom fields . | list_id (integer) page (integer) limit (integer) ordersort (string) orderid (string) filtertype0 (string) |
| post_api_v4_catalogs_by_list_id_custom_fields | This method allows adding singular or multiple custom fields to a list | list_id (integer) data: { . RAW_BODY (array) } (object) required |
| patch_api_v4_by_entity_type_custom_fields_by_id | This method allows to update a singular custom field of an entityleads/contacts/companies | entity_type (string) id (integer) data: { . name (string) . sort (integer) . group_id (string) . is_api_only (boolean) . required_statuses (array) . enums (array) . remind (string) . tracking_callback (string) . hidden_statuses (array) . chained_lists (array) . search_in (string) . currency (string) } (object) required |
| get_api_v4_by_entity_type_custom_fields_by_id | This method allows to get a list of custom fields in the account leads, companies, contacts | entity_type (string) id (integer) |
| get_api_v4_catalogs_by_list_id_custom_fields_by_custom_field_id | This method allows to get a list of custom fields in the account. | list_id (integer) custom_field_id (integer) |
| patch_api_v4_catalogs_by_id_custom_fields | This method allows updating multiple custom fields of a list | id (integer) data: { . RAW_BODY (array) } (object) required |
| patch_api_v4_catalogs_by_list_id_custom_fields_by_cf_id | This method allows updating a custom field of a list. | list_id (integer) cf_id (integer) data: { . RAW_BODY (object) } (object) required |
| delete_api_v4_by_entity_custom_fields_by_id | This method allows you to delete a custom field of an entity on the account | entity (string) id (integer) |
| get_api_v4_users | This method allows to get the data of the user on the account by user’s ID | with (string) page (integer) limit (integer) |
| post_api_v4_users | This method allows to add multiple users to the account | data: { . RAW_BODY (array) } (object) required |
| get_api_v4_roles | This method allows getting a list of user roles on the account | with (string) page (integer) limit (integer) |
| post_api_v4_roles | This method allows to add multiple roles to the account | data: { . RAW_BODY (array) } (object) required |
| delete_api_v4_roles_by_id | This method allows deleting a user role from the account | id (integer) |
| patch_api_v4_roles_by_id | This method allows editing user roles. | id (string) data: { . RAW_BODY (object) } (object) required |
| get_api_v4_roles_by_id | This method allows getting a particular role data by its ID | id (integer) with (string) |
| get_api_v4_tasks | Tasks list | page (integer) limit (integer) filterresponsible_user_id (array) filteris_completed (integer) filtertask_type (array) filterentity_type (string) filterentity_id (array) filterid (array) filterupdated_at (integer) filterupdated_atfrom (integer) filterupdated_atto (integer) ordercomplete_till (string) ordercreated_at (string) orderid (string) |
| post_api_v4_tasks | This method allows adding multiple tasks. | data: { . RAW_BODY (array) } (object) required |
| patch_api_v4_tasks | This method allows to edit multiple tasks. When updating multiple tasks, an array of task objects is passed. | data: { . RAW_BODY (array) } (object) required |
| patch_api_v4_tasks_by_id | To edit a singular task, you can add the task ID into the method URL. The task object is passed. | id (integer) data: { . RAW_BODY (object) } (object) required |
| get_api_v4_tasks_by_id | This method allows to get a particular task data by its ID. | id (integer) |
| get_api_v4_events | This method allows getting the events list | with (string) page (integer) limit (integer) filterid (string) filtercreated_atfrom (integer) filtercreated_atto (integer) filtercreated_by (string) filterentity (string) filterentity_id (string) filtertype (string) |
| get_api_v4_events_by_id | This method allows getting a particular event data by its ID. | id (string) with (string) |
| get_api_v4_events_types | This method allows getting all available events types | language_code (string) |
| get_api_v4_by_entity_type_by_entity_id_notes | This method allows getting a notes list by the ID of the parent entity | entity_type (string) entity_id (integer) page (integer) limit (integer) filterid (array) filternote_type (array) filterupdated_atfrom (integer) filterupdated_atto (integer) orderupdated_at (string) orderid (string) with (string) |
| get_api_v4_by_entity_type_notes | This method allows getting a list of notes by the entity type | entity_type (string) page (integer) limit (integer) filterid (array) filternote_type (array) filterupdated_atfrom (integer) filterupdated_atto (integer) orderupdated_at (string) orderid (string) with (string) |
| post_api_v4_by_entity_type_notes | This method allows adding multiple notes | entity_type (string) data: { . RAW_BODY (array) } (object) required |
| patch_api_v4_by_entity_type_notes | This method allows to edit multiple notes. An array of objects is passed. | entity_type (string) data: { . RAW_BODY (array) } (object) required |
| get_api_v4_by_entity_type_notes_by_id | This method allows getting a particular note data by its ID | entity_type (string) id (integer) |
| patch_api_v4_by_entity_type_notes_by_id | This method allows to edit multiple notes. An array of objects is passed. | entity_type (string) id (integer) data: { . RAW_BODY (object) } (object) required |
| get_api_v4_by_entity_type_tags | This method allows to get the list of entity tags on the account | entity_type (string) page (integer) limit (integer) query (string) filterid (array) filtername (string) |
| post_api_v4_by_entity_type_tags | This method allows adding multiple tags for a particular entity specified in the method URL | entity_type (string) data: { . RAW_BODY (array) } (object) required |
| patch_api_v4_by_entity_type | This method allows updating multiple entities. An array of entity objects is passed. | entity_type (string) data: { . RAW_BODY (array) } (object) required |
| patch_api_v4_by_entity_type_by_id | This method allows updating tags of a single entity. An object should be passed. | entity_type (string) id (integer) data: { . _embedded (object) } (object) required |
| get_api_v4_by_entity_by_entity_id_links | This method allows getting a list of entities linked to a lead/contact/company by the ID of the lead, contact or company. | entity (string) entity_id (integer) filterto_entity_id (integer) filterto_entity_type (string) filterto_catalog_id (integer) |
| post_api_v4_by_entity_by_entity_id_link | This method allows linking entities to a lead, contact or company. | entity (string) entity_id (integer) data: { . RAW_BODY (array) } (object) required |
| post_api_v4_by_entity_by_entity_id_unlink | This method allows unlinking entities from a lead, contact or company. | entity (string) entity_id (integer) data: { . RAW_BODY (array) } (object) required |
| post_api_v2_salesbot_run | Method for launching Salesbot. | data: { . RAW_BODY (array) } (object) required |
| post_api_v4_by_bot_by_bot_id_continue_by_continue_id | SalesBot widget block execution confirmation | bot_id (integer) continue_id (integer) bot (string) data: { . data (string) . execute_handlers (string) } (object) required |
| get_api_v4_sources | The method allows you to get a list of the integration sources | filterexternal_id (array) |
| post_api_v4_sources | The method allows you to post a list of the integration sources. | data: { . RAW_BODY (array) } (object) required |
| patch_api_v4_sources | The method allows you to edit sources in batches. | data: { . RAW_BODY (array) } (object) required |
| delete_api_v4_sources | The method allows you to delete the integration sources in batches. An array of source objects is passed. | data: { . RAW_BODY (array) } (object) required |
| get_api_v4_sources_by_id | The method returns a source object. | id (integer) |
| patch_api_v4_sources_by_id | The method allows you to edit a specific source. | id (integer) data: { . RAW_BODY (object) } (object) required |
| delete_api_v4_sources_by_id | The method allows you to remove a specific source. No request body is not required to be passed. | id (integer) |
| get_api_v4_website_buttons | The method allows you to get a paginated list of parameters of all CRM Plugins in your account. | with (string) page (integer) limit (integer) |
| post_api_v4_website_buttons | This method enables you to add a CRM Plugin. Once you make the request, the source in the pipeline is created immediately, while the CRM Plugin settings are created asynchronously outside the context of the request. | data: { . pipeline_id (integer) . trusted_websites (array) . is_used_in_app (boolean) } (object) required |
| get_api_v4_website_buttons_by_source_id | The method allows you to obtain the parameters of one CRM Plugin. | source_id (integer) with (string) |
| patch_api_v4_website_buttons_by_source_id | This method enables users to modify an existing CRM Plugin. Users can add new trusted domains to an existing CRM Plugin, but the addition occurs asynchronously, outside of the request context. | source_id (integer) data: { . trusted_websites (object) } (object) required |
| post_api_v4_website_buttons_by_source_id_online_chat | This method enables you to link an online chat to the CRM Plugin. The process of creating an online chat and connecting it to the CRM Plugin happens asynchronously, and not in the context of a request. | source_id (string) |
| get_api_v4_chats_templates | The method allows you to get a list of templates in your account. | page (integer) limit (integer) filterexternal_id (array) with (string) |
| post_api_v4_chats_templates | The method allows adding templates in a bunch. | data: { . RAW_BODY (array) } (object) required |
| patch_api_v4_chats_templates | The method allows editing templates in a bunch. | data: { . RAW_BODY (array) } (object) required |
| delete_api_v4_chats_templates | The method allows deleting a template in your account. You can delete either a specific template or several templates at once. If the file attached to the template has not been used anywhere else, or all entities where it was used have been deleted, then the file will be deleted along with the template, otherwise the file will not be deleted and will be available in Media list. | data: { . RAW_BODY (array) } (object) required |
| get_api_v4_chats_templates_by_id | The method allows you to get data about a template. | id (integer) with (string) |
| delete_api_v4_chats_templates_by_id | The method allows deleting a template in your account. If the file attached to the template has not been used anywhere else, or all entities where it was used have been deleted, then the file will be deleted along with the template, otherwise the file will not be deleted and will be available in Media list. | id (integer) |
| post_api_v4_chats_templates_by_id_review | The method allows submitting a WhatsApp template for moderation. | id (integer) |
| post_api_v4_chats_templates_by_id_review_by_review_id | The method allows editing the WhatsApp template status. | id (integer) review_id (integer) data: { . status (string) . reject_reason (string) } (object) required |
| get_api_v4_webhooks | The method allows getting a list of webhooks. | filterdestination (string) |
| post_api_v4_webhooks | The method allows creating a webhook to sent event notifications to the specified URL. | data: { . RAW_BODY (object) } (object) required |
| delete_api_v4_webhooks | The method allows you to delete a webhook. | data: { . destination (string) } (object) required |
| get_api_v4_widgets | This method returns an aggregated list of public widgets installed on the account as well as widgets added by the current user. | page (integer) limit (integer) |
| get_api_v4_widgets_by_widget_code | This method allows getting the information on a public widget or a private widget uploaded by the current user. | widget_code (string) |
| post_api_v4_widgets_by_widget_code | This method allows installing the widget into the account. | widget_code (string) data: { . RAW_BODY (string) } (object) required |
| delete_api_v4_widgets_by_widget_code | This method allows uninstalling a widget by its code. | widget_code (string) |
| get_api_v4_talks_by_id | The method allows you to obtain data for a specific conversation by its ID | id (integer) |
| post_api_v4_talks_by_id_close | Method allows you to launch a NPS bot or close a conversation by its ID. NPS bot is being launched only when it is enabled in the account settings, available in your plan and no force_close parameter is supplied. | id (integer) data: { . force_close (boolean) } (object) required |
| post_api_v4_calls | This method allows adding multiple calls | data: { . RAW_BODY (array) } (object) required |
| get_api_v4_by_entity_by_entity_id_files | The method allows to get files attached to a chosen entity. | entity (string) entity_id (integer) limit (integer) before_id (integer) |
| put_api_v4_by_entity_by_entity_id_files | The method allows to attach files to a chosen entity. | entity (string) entity_id (integer) data: { . RAW_BODY (array) } (object) required |
| delete_api_v4_by_entity_by_entity_id_files | The method allows to detach files from a chosen entity. | entity (string) entity_id (integer) data: { . RAW_BODY (array) } (object) required |
| get_api_v4_files_by_file_uuid_links | This method allows to get entities associated with a file. | file_uuid (string) |
| post_api_v4_contacts_chats | The method allows you to link an existing chat to a contact. | data: { . RAW_BODY (array) } (object) required |
| get_api_v4_contacts_chats | The method allows you to retrieving a contact’s chats. | contact_id (integer) chat_id (string) |
| get_api_v4_by_entity_type_custom_fields_groups | No description available | entity_type (string) |
| post_api_v4_by_entity_type_custom_fields_groups | No description available | entity_type (string) data: { . RAW_BODY (array) } (object) required |
| get_api_v4_by_entity_type_custom_fields_groups_by_id | No description available | entity_type (string) id (string) |
| patch_api_v4_by_entity_type_custom_fields_groups_by_id | No description available | entity_type (string) id (string) data: { . name (string) . sort (integer) . fields (array) } (object) required |
| delete_api_v4_by_entity_type_custom_fields_groups_by_id | No description available | entity_type (string) id (string) |
| post_api_v2_events | No description available | data: { . add (array) } (object) required |
| get_api_v4_leads_loss_reasons | No description available | No parameters |
| post_api_v4_by_entity_type_notes_by_id_pin | Pin note | entity_type (string) id (integer) |
| post_api_v4_by_entity_type_notes_by_id_unpin | Unpin note | entity_type (string) id (integer) |
| get_api_v4_leads_loss_reasons_by_id | Copy of | id (string) |
| post_api_v4_bots_by_id_stop | No description available | id (integer) data: { . entity_id (integer) . entity_type (string) } (object) required |
| post_api_v4_bots_run | No description available | data (array) required |
| get_api_v4_bots | The method allows getting a list of Salesbots in the account | page (integer) limit (integer) filtertype_functionality (array) filterid (array) with (string) |
| post_api_v4_users_activate | This method allows to activate users in the account in bulk | data (array) required |
| post_api_v4_users_deactivate | This method allows to deactivate users in the account in bulk | data (array) required |
| get_api_v4_bots_by_id | The method allows to obtain a Salesbot by its ID | id (integer) with (string) |
| get_api_v4_users_by_id | This method allows to get the data of the user on the account by user’s ID | id (integer) with (string) |
| post_api_v4_talks_by_talk_id_send_message | The method allows to send a message to a conversation. | talk_id (integer) data: { . text (string) . attachment (object) } (object) required |
| post_api_v4_bots_by_id_run | Launch Salesbot | id (integer) data: { . entity_id (integer) . entity_type (string) } (object) required |
| get_api_v4_talks | The method returns a collection of conversations in the account. | page (integer) limit (integer) filtertalk_id (array) filtercontact_id (array) filterentity_id (array) filterentity_type (string) filteronly_in_work (string) |
| get_api_v4_talks_by_talk_id_messages | The method allows to retrieve messages from a conversation. | talk_id (integer) page (integer) limit (integer) filtercreated_atfrom (integer) filtercreated_atto (integer) |
| get_api_v4_account | The method allows getting the account information. | with (string) |
| custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body _headers (object) |