v1
latestOpenAPI 3.1.02026-07-241630614.2 KBLinked entities list
This method allows getting a list of entities linked to a lead/contact/company by the ID of the lead, contact or company.
get/api/v4/{entity}/{entity_id}/links
Path parameters
entity'leads' | 'contacts' | 'companies' required
Entity type
entity_idinteger required
Entity ID
Query parameters
filter[to_entity_id]integer
Filter by the ID of the linked entity. You should also pass a value to filter[to_entity_type]
filter[to_entity_type]string
Filter by the type of the linked entity. You should also pass a value to filter[to_entity_id]
filter[to_catalog_id]integer
Filter by the ID of the linked entity list
Response
200
Example response
{
"_total_items": 4,
"_links": {
"self": {
"href": "https://example.kommo.com/api/v4/leads/7593303/links?page=1&limit=50"
}
},
"_embedded": {
"links": [
{
"to_entity_id": 597393,
"to_entity_type": "catalog_elements",
"metadata": {
"quantity": 1,
"catalog_id": 4521
}
}
]
}
}