get https://{subdomain}.kommo.com/api/v4/leads
Este método permite obter uma lista de leads 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 |
|---|---|
| contacts | Adiciona informações sobre os contatos associados ao lead à resposta |
| only_deleted | Se este parâmetro for passado, a solicitação do método retornará apenas os leads deletados que ainda são restauráveis na resposta. Você receberá modelos de lead com as seguintes propriedades: “id”, data de modificação e parâmetro “is_deleted” = true |
| loss_reason | Adiciona informações detalhadas sobre o motivo da perda do lead à resposta |
| is_price_modified_by_robot | Adiciona uma propriedade que representa se o valor da venda do lead foi alterado pela última vez por um Robô à resposta |
| catalog_elements | Adiciona itens de listas vinculados ao lead à resposta |
| source_id | Adiciona o ID da fonte do lead à resposta |
filter[statuses]
Devido às limitações do serviço, você pode filtrar apenas um estágio em um pipeline. Porém, é possível filtrar vários estágios dentro de vários pipelines fora do serviço.
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 do Lead |
| name | string | Nome do Lead |
| price | int | Venda do Lead |
| responsible_user_id | int | ID do usuário responsável pelo Lead |
| group_id | int | ID do Grupo do usuário responsável pelo Lead |
| status_id | int | ID da Etapa à qual o Lead foi adicionado, sendo a primeira etapa do pipeline principal a padrão |
| pipeline_id | int | ID do Pipeline ao qual o Lead foi adicionado |
| loss_reason_id | int | ID do motivo da perda do Lead |
| source_id | int | O parâmetro GET “with” é obrigatório. ID da Fonte do Lead |
| created_by | int | ID do Usuário que criou o Lead |
| updated_by | int | ID do Usuário que atualizou o Lead |
| created_at | int | A data e hora em que o lead foi criado no formato de Unix Timestamp |
| updated_at | int | A data e hora em que o lead foi atualizado no formato de Unix Timestamp |
| closed_at | int | A data e hora em que o lead foi fechado no formato de Unix Timestamp |
| closest_task_at | int | A data e hora da tarefa aberta mais próxima no formato de Unix Timestamp |
| custom_fields_values | array|null | Um array contendo informações sobre os valores dos campos personalizados especificados para este Lead |
| score | int|null | Pontuação do Lead |
| account_id | int | ID da Conta onde o Lead está localizado |
| labor_cost | int | Mostra quanto tempo foi gasto trabalhando com o negócio. O tempo é calculado em segundos. |
| is_price_modified_by_robot | bool | O parâmetro GET “with” é obrigatório. Defines whether the lead sale value was changed by the Robot last time |
| _embedded | object | Dados de entidades incorporadas |
| _embedded[loss_reason] | object | O parâmetro GET “with” é obrigatório. Razão da perda do Lead |
| _embedded[loss_reason][id] | int | ID da razão da perda |
| _embedded[loss_reason][name] | string | Nome da razão da perda |
| _embedded[tags] | array | Array de dados das tags do Lead |
| _embedded[tags][0] | object | Modelo de tag do Lead |
| _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[contacts] | array | O parâmetro GET “with” é obrigatório. Array de dados dos contatos vinculados |
| _embedded[contacts][0] | object | Dados do contato vinculado |
| _embedded[contacts][0][id] | ints | ID do contato vinculado |
| _embedded[contacts][0][is_main] | bool | Define se o contato é principal para o lead |
| _embedded[companies] | array | Array de dados das empresas vinculadas. Este array sempre consiste em 1 elemento, pois o lead pode ter apenas 1 empresa vinculada |
| _embedded[companies][0] | object | Dados da empresa vinculada |
| _embedded[companies][0][id] | int | ID da empresa vinculada |
| _embedded[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 da lista vinculada |
| _embedded[catalog_elements][0][id] | int | ID do elemento vinculado |
| _embedded[catalog_elements][0][metadata] | object | Meta-dados do elemento |
| _embedded[catalog_elements][0][quantity] | int | Quantidade do elemento vinculado |
| _embedded[catalog_elements][0][catalog_id] | int | ID da lista do elemento vinculado |