get
https://{subdomain}.kommo.com/api/v4/leads/unsorted
Este método permite obter uma lista de leads recebidos na conta
Limitações
O método está disponível de acordo com os direitos do usuário.
Tipo de autorização
OAuth 2.0 com Token de Acesso / Token de Longa Duraçã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
Um exemplo da solicitação
No exemplo a seguir, obteremos uma única lista de leads de entrada.
https://example.kommo.com/api/v4/leads/unsorted?filter[uid]=5af9dedb6f2c6a29eaac6ee37fc75ffbb66e139e4603bdd0e14e39d4b319Parâmetros de resposta
| Parâmetro | Tipo de dado | Descrição |
|---|---|---|
| uid | string | UID do lead de entrada |
| source_uid | string | UID da fonte do lead de entrada. Gerado pela integração |
| source_name | string | Nome da fonte do lead de entrada |
| category | string | Categoria do lead de entrada: sip, mail, chats, forms |
| pipeline_id | int | ID do pipeline em que o lead de entrada está localizado |
| created_at | int | Data e hora de criação do lead de entrada no formato Unix Timestamp |
| metadata | object | Metadados do lead de entrada. Cada tipo possui seus próprios parâmetros. |
| account_id | int | ID da conta em que o lead de entrada está localizado |
| _embedded | object | Dados de entidades incorporadas |
| _embedded[contacts] | array | Dados relacionados ao contato do lead de entrada. Sempre consiste em um objeto |
| _embedded[0] | object | Modelo de Contato |
| _embedded[0][id] | int | ID do Contato |
| _embedded[companies] | array | Dados relacionados à empresa do lead de entrada. Sempre consiste em um objeto |
| _embedded[0] | object | Modelo de Empresa |
| _embedded[0][id] | int | ID da Empresa |
| _embedded[leads] | array | Dados relacionados ao lead ao qual o lead de entrada está conectado. Sempre consiste em um objeto |
| _embedded[0] | object | Modelo de Lead |
| _embedded[0][id] | int | ID do Lead |