v1

latestOpenAPI 3.1.02026-07-261620662.2 KB

Lista de Contatos

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

get/api/v4/contacts

Path parameters

withstring required

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

pageinteger required

Página de exemplo

limitinteger required

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

querystring required

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

order[updated_at]'asc' | 'desc' required

Ordenação dos elementos da lista

order[id]'asc' | 'desc' required

Ordenação dos elementos da lista

filter[id][]integer[] required

Filtro pelo ID do contato

filter[name][]string[] required

Filtro pelo nome do contato

filter[created_by][]integer[] required

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

filter[updated_by][]integer[] required

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

filter[responsible_user_id][]integer[] required

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

filter[created_at][from]integer required

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

filter[created_at][from]integer 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]integer 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]integer 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]integer required

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

filter[closest_task_at][to]integer required

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

Response

200

_pageinteger

Example response

{
  "_page": 1,
  "_links": {
    "self": {
      "href": "https://devteam.kommo.com/api/v4/contacts"
    }
  },
  "_embedded": {
    "contacts": [
      {
        "id": 406322,
        "name": "Samuel",
        "first_name": "Samuel",
        "responsible_user_id": 8375357,
        "created_by": 8375357,
        "updated_by": 8375357,
        "created_at": 1686670710,
        "updated_at": 1686670710,
        "custom_fields_values": [
          {
            "field_id": 178382,
            "field_name": "Telefone",
            "field_code": "PHONE",
            "field_type": "multitext",
            "values": [
              {
                "value": "19651796212",
                "enum_id": 126290,
                "enum_code": "WORK"
              }
            ]
          }
        ],
        "account_id": 31361463,
        "_links": {
          "self": {
            "href": "https://devteam.kommo.com/api/v4/contacts/406322"
          }
        },
        "_embedded": {
          "companies": [
            {
              "id": 406320,
              "_links": {
                "self": {
                  "href": "https://devteam.kommo.com/api/v4/companies/406320"
                }
              }
            }
          ]
        }
      }
    ]
  }
}