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.

Limitações
O método está disponível de acordo com os direitos do usuário.

Cabeçalho de tipo de dado quando a solicitação é bem-sucedida
Content-Type: application/hal+json

Cabeçalho de tipo de dado em caso de erro
Content-Type: application/problem+json

Parâmetros de resposta

ParâmetroTipo de dadoDescrição
to_entity_idintID da entidade vinculada
to_entity_typestringTipos de entidades vinculadas (leads, contacts, companies, catalog_elements)
metadataobject|nullMetadados da entidade vinculada
metadata[main_contact]boolDefine se o contato é principal para a entidade
metadata[quantity]intQuantidade de elementos da lista vinculados
metadata[catalog_id]intID da lista
metadata[updated_by]intID do usuário que está realizando o vínculo
Path Params
string
enum
required

Tipo de entidade

Allowed:
int32
required

ID da entidade

Query Params
int32

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

string
enum

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

Allowed:
int32

Filtrar pelo ID da lista de entidades vinculadas

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