Obtendo um contato pelo seu ID

Este método permite obter os dados de um contato específico pelo seu ID

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

Parâmetros “with”

ParâmetroDescrição
leadsAdiciona informações sobre os leads vinculados ao contato na resposta
catalog_elementsAdiciona elementos das listas vinculados ao contato na resposta

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âmetro

Tipo de dado

Descrição

id

int

ID de Contato

name

string

Nome completo do Contato

first_name

string

Primeiro nome do Contato

last_name

string

Último nome do Contato

responsible_user_id

int

ID do usuário responsável pelo Contato

group_id

int

ID do Grupo do usuário responsável pelo Contato

created_by

int

ID do usuário que criou o Contato

updated_by

int

ID do usuário que atualizou o Contato pela última vez

created_at

int

Data de criação do Contato no formato Unix Timestamp

updated_at

int

Data de atualização do Contato no formato Unix Timestamp

closest_task_at

int

Data da tarefa aberta mais próxima no formato Unix Timestamp

custom_fields_values

array|null

Um array dos valores dos campos personalizados atuais do contato

account_id

int

ID da conta onde o contato está localizado

  • embedded

object

Dados das entidades incorporadas

  • embedded[tags]

array

Array de dados das Tags do contato

  • embedded[tags][0]

object

Modelo da Tag do contato

  • embedded[tags][0][id]

int

ID da Tag

  • embedded[tags][0][name]

string

Nome da Tag

  • embedded[tags][0][color]

string/null

Cor da Tag

  • embedded[companies]

array

Array de dados da empresa vinculada. Este array sempre consiste em 1 elemento.

  • embedded[companies][0]

object

Dados da Empresa vinculada

  • embedded[companies][0][id]

int

ID da Empresa vinculada

  • embedded[leads]

array

O parâmetro GET “with” é obrigatório
Array de dados dos leads vinculados

  • embedded[leads][0]

object

Dados do lead vinculado

  • embedded[leads][0][id]

int

ID do lead vinculado

  • embedded[catalog_elements][catalog_elements]

array

O parâmetro GET “with” é obrigatório
Array de dados dos elementos das listas vinculadas

  • embedded[catalog_elements][0]

object

Dados do elemento vinculado da lista

  • embedded[catalog_elements][0][id]

int

ID do elemento vinculado

  • embedded[catalog_elements][0][metadata]

object

Metadados do elemento

  • embedded[catalog_elements][0][quantity]

int

Quantidade de elementos vinculados

  • embedded[catalog_elements][0][catalog_id][catalog_id]

int

ID da lista do elemento vinculado

Language
Credentials
OAuth2
URL
Click Try It! to start a request and see the response here!