v1

latestOpenAPI 3.1.02026-07-261620662.2 KB

Lista de entidades vinculadas

Este método permite obter uma lista de entidades vinculadas a um negócio/contato/empresa pelo ID do negócio, contato ou empresa.

get/api/v4/{entity}/{entity_id}/links

Path parameters

entity'leads' | 'contacts' | 'companies' required

Tipo de entidade

entity_idinteger required

ID da entidade

Query parameters

filter[to_entity_id]integer

Filtrar pelo ID da entidade vinculada. Você também deve passar um valor para filter[to_entity_type]

filter[to_entity_type]'leads' | 'contacts' | 'companies' | 'catalog_elements'

Filtrar pelo tipo da entidade vinculada. Você também deve passar um valor para filter[to_entity_id]

filter[to_catalog_id]integer

Filtrar pelo ID da lista de entidades vinculadas

Response

200

_total_itemsinteger

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
        }
      }
    ]
  }
}