← Tools Reference

Kommo

Kommo integration (Marketing, Productivity). Imported from open-connector.

API key13 toolshttps://{subdomain}{kommo_host_suffix}
GET
kommo_get_account
Get Kommo account information for the connected account.

/api/v4/account

1 parameter
ParamTypeRequiredDescription
withstringoptionalComma-separated Kommo with parameters to include.
GET
kommo_list_leads
List leads from the connected Kommo account.

/api/v4/leads

24 parameters
ParamTypeRequiredDescription
pageintegeroptionalThe 1-based Kommo result page to fetch.
limitintegeroptionalThe number of Kommo records to fetch per request.
querystringoptionalSearch text forwarded to Kommo.
withstringoptionalComma-separated Kommo with parameters to include.
orderUpdatedAtstringoptionalThe Kommo sort direction.
orderIdstringoptionalThe Kommo sort direction.
idsarrayoptionalOne or more Kommo numeric identifiers.
namesarrayoptionalOne or more Kommo names to filter by.
createdByIdsarrayoptionalOne or more Kommo numeric identifiers.
updatedByIdsarrayoptionalOne or more Kommo numeric identifiers.
responsibleUserIdsarrayoptionalOne or more Kommo numeric identifiers.
updatedAtFromintegeroptionalA Unix timestamp in seconds.
updatedAtTointegeroptionalA Unix timestamp in seconds.
closestTaskAtFromintegeroptionalA Unix timestamp in seconds.
closestTaskAtTointegeroptionalA Unix timestamp in seconds.
orderCreatedAtstringoptionalThe Kommo sort direction.
priceintegeroptionalThe exact lead sale value to filter by.
createdAtFromintegeroptionalA Unix timestamp in seconds.
createdAtTointegeroptionalA Unix timestamp in seconds.
closedAtFromintegeroptionalA Unix timestamp in seconds.
closedAtTointegeroptionalA Unix timestamp in seconds.
pipelineIdsarrayoptionalOne or more Kommo numeric identifiers.
statusPipelineIdintegeroptionalThe Kommo numeric identifier.
statusIdintegeroptionalThe Kommo numeric identifier.
GET
kommo_get_lead
Get one Kommo lead by ID.

/api/v4/leads/{id}

2 parameters
ParamTypeRequiredDescription
idintegerrequiredThe Kommo numeric identifier.
withstringoptionalComma-separated Kommo with parameters to include.
GET
kommo_list_contacts
List contacts from the connected Kommo account.

/api/v4/contacts

15 parameters
ParamTypeRequiredDescription
pageintegeroptionalThe 1-based Kommo result page to fetch.
limitintegeroptionalThe number of Kommo records to fetch per request.
querystringoptionalSearch text forwarded to Kommo.
withstringoptionalComma-separated Kommo with parameters to include.
orderUpdatedAtstringoptionalThe Kommo sort direction.
orderIdstringoptionalThe Kommo sort direction.
idsarrayoptionalOne or more Kommo numeric identifiers.
namesarrayoptionalOne or more Kommo names to filter by.
createdByIdsarrayoptionalOne or more Kommo numeric identifiers.
updatedByIdsarrayoptionalOne or more Kommo numeric identifiers.
responsibleUserIdsarrayoptionalOne or more Kommo numeric identifiers.
updatedAtFromintegeroptionalA Unix timestamp in seconds.
updatedAtTointegeroptionalA Unix timestamp in seconds.
closestTaskAtFromintegeroptionalA Unix timestamp in seconds.
closestTaskAtTointegeroptionalA Unix timestamp in seconds.
GET
kommo_get_contact
Get one Kommo contact by ID.

/api/v4/contacts/{id}

2 parameters
ParamTypeRequiredDescription
idintegerrequiredThe Kommo numeric identifier.
withstringoptionalComma-separated Kommo with parameters to include.
GET
kommo_list_companies
List companies from the connected Kommo account.

/api/v4/companies

17 parameters
ParamTypeRequiredDescription
pageintegeroptionalThe 1-based Kommo result page to fetch.
limitintegeroptionalThe number of Kommo records to fetch per request.
querystringoptionalSearch text forwarded to Kommo.
withstringoptionalComma-separated Kommo with parameters to include.
orderUpdatedAtstringoptionalThe Kommo sort direction.
orderIdstringoptionalThe Kommo sort direction.
idsarrayoptionalOne or more Kommo numeric identifiers.
namesarrayoptionalOne or more Kommo names to filter by.
createdByIdsarrayoptionalOne or more Kommo numeric identifiers.
updatedByIdsarrayoptionalOne or more Kommo numeric identifiers.
responsibleUserIdsarrayoptionalOne or more Kommo numeric identifiers.
updatedAtFromintegeroptionalA Unix timestamp in seconds.
updatedAtTointegeroptionalA Unix timestamp in seconds.
closestTaskAtFromintegeroptionalA Unix timestamp in seconds.
closestTaskAtTointegeroptionalA Unix timestamp in seconds.
createdAtFromintegeroptionalA Unix timestamp in seconds.
createdAtTointegeroptionalA Unix timestamp in seconds.
GET
kommo_get_company
Get one Kommo company by ID.

/api/v4/companies/{id}

2 parameters
ParamTypeRequiredDescription
idintegerrequiredThe Kommo numeric identifier.
withstringoptionalComma-separated Kommo with parameters to include.
GET
kommo_list_tasks
List tasks from the connected Kommo account.

/api/v4/tasks

14 parameters
ParamTypeRequiredDescription
pageintegeroptionalThe 1-based Kommo result page to fetch.
limitintegeroptionalThe number of Kommo records to fetch per request.
responsibleUserIdsarrayoptionalOne or more Kommo numeric identifiers.
isCompletedbooleanoptionalWhether to filter completed tasks.
taskTypeIdsarrayoptionalOne or more Kommo numeric identifiers.
entityTypestringoptionalThe linked entity type to filter by.
entityIdsarrayoptionalOne or more Kommo numeric identifiers.
idsarrayoptionalOne or more Kommo numeric identifiers.
updatedAtintegeroptionalA Unix timestamp in seconds.
updatedAtFromintegeroptionalA Unix timestamp in seconds.
updatedAtTointegeroptionalA Unix timestamp in seconds.
orderCompleteTillstringoptionalThe Kommo sort direction.
orderCreatedAtstringoptionalThe Kommo sort direction.
orderIdstringoptionalThe Kommo sort direction.
GET
kommo_get_task
Get one Kommo task by ID.

/api/v4/tasks/{id}

1 parameter
ParamTypeRequiredDescription
idintegerrequiredThe Kommo numeric identifier.
GET
kommo_list_users
List users from the connected Kommo account.

/api/v4/users

3 parameters
ParamTypeRequiredDescription
withstringoptionalComma-separated Kommo with parameters to include.
pageintegeroptionalThe 1-based Kommo result page to fetch.
limitintegeroptionalThe number of Kommo records to fetch per request.
GET
kommo_get_user
Get one Kommo user by ID.

/api/v4/users/{id}

2 parameters
ParamTypeRequiredDescription
idintegerrequiredThe Kommo numeric identifier.
withstringoptionalComma-separated Kommo with parameters to include.
GET
kommo_list_pipelines
List lead pipelines from the connected Kommo account.

/api/v4/leads/pipelines

GET
kommo_get_pipeline
Get one Kommo lead pipeline by ID.

/api/v4/leads/pipelines/{id}

1 parameter
ParamTypeRequiredDescription
idintegerrequiredThe Kommo numeric identifier.