Lista de Contatos

get

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

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

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

200200

400400