Linked 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.

Limitations
The method is available in correspondence to the user rights.

Data type header when the request is successful
Content-Type: application/hal+json

Data type header in case of an error
Content-Type: application/problem+json

Response parameters

ParameterData typeDescription
to_entity_idintLinked entity ID
to_entity_typestringLinked entity types (leads, contacts, companies, catalog_elements)
metadataobject|nullLinked entity metadata
metadata[main_contact]boolDefines if the contact is main for the entity
metadata[quantity]intQuantity of the linked list elements
metadata[catalog_id]intList ID
metadata[updated_by]intThe ID of the user performing the linking
Path Params
string
enum
required

Entity type

Allowed:
int32
required

Entity ID

Query Params
int32

Filter by the ID of the linked entity. You should also pass a value to filter[to_entity_type]

string

Filter by the type of the linked entity. You should also pass a value to filter[to_entity_id]

int32

Filter by the ID of the linked entity list

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json