Lista de Contatos

get

https://{subdomain}.kommo.com/api/v4/contacts

Este método permite obter uma lista de contatos na conta

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

Parâmetros “with”

Parâmetro	Descrição
leads	Adiciona informações sobre os leads vinculados ao contato na resposta
catalog_elements	Adiciona 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

Path Params

with

string

required

Este parâmetro aceita uma string que pode consistir em vários valores separados por vírgulas.

page

int32

required

Página de exemplo

limit

int32

required

O número de entidades retornadas na resposta de uma solicitação (limite – 250)

query

string

required

String ou inteiro. A consulta de pesquisa realizará uma busca pelos valores dos campos personalizados.

order[updated_at]

string

enum

required

Ordenação dos elementos da lista

Allowed:

order[id]

string

enum

required

Ordenação dos elementos da lista

Allowed:

filter[id][]

array of int32s

required

Filtro pelo ID do contato

filter[id][]*

filter[name][]

array of strings

required

Filtro pelo nome do contato

filter[name][]*

filter[created_by][]

array of int32s

required

Filtro pelo ID do usuário que adicionou o(s) contato(s)

filter[created_by][]*

filter[updated_by][]

array of int32s

required

Filtro pelo ID do usuário que atualizou o contato por último

filter[updated_by][]*

filter[responsible_user_id][]

array of int32s

required

Filtro pelo ID do usuário responsável pelo contato

filter[responsible_user_id][]*

filter[created_at][from]

int32

required

Filtro pela data de criação do contato no formato Unix Timestamp. Como resposta, você receberá todos os contatos adicionados antes da data.

filter[updated_at][from]

int32

required

Filtro pela data no formato Unix Timestamp em que o contato foi atualizado. Como resposta, você receberá todos os contatos atualizados após a data.

filter[updated_at][to]

int32

required

Filtro pela data no formato Unix Timestamp em que o contato foi atualizado. Como resposta, você receberá todos os contatos atualizados antes da data.

filter[closest_task_at][from]

int32

required

Filtro de contatos pela data no formato Unix Timestamp da tarefa mais próxima da conclusão.

filter[closest_task_at][to]

int32

required

Filtro de contatos pela data no formato Unix Timestamp da tarefa mais próxima da conclusão.

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400