Lista de Leads de entrada

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]=5af9dedb6f2c6a29eaac6ee37fc75ffbb66e139e4603bdd0e14e39d4b319

Parâmetros de resposta

ParâmetroTipo de dadoDescrição
uidstringUID do lead de entrada
source_uidstringUID da fonte do lead de entrada. Gerado pela integração
source_namestringNome da fonte do lead de entrada
categorystringCategoria do lead de entrada: sip, mail, chats, forms
pipeline_idintID do pipeline em que o lead de entrada está localizado
created_atintData e hora de criação do lead de entrada no formato Unix Timestamp
metadataobjectMetadados do lead de entrada. Cada tipo possui seus próprios parâmetros.
account_idintID da conta em que o lead de entrada está localizado
_embeddedobjectDados de entidades incorporadas
_embedded[contacts]arrayDados relacionados ao contato do lead de entrada. Sempre consiste em um objeto
_embedded[contacts][0]objectModelo de Contato
_embedded[contacts][0][id]intID do Contato
_embedded[companies]arrayDados relacionados à empresa do lead de entrada. Sempre consiste em um objeto
_embedded[companies][0]objectModelo de Empresa
_embedded[companies][0][id]intID da Empresa
_embedded[leads]arrayDados relacionados ao lead ao qual o lead de entrada está conectado. Sempre consiste em um objeto
_embedded[leads][0]objectModelo de Lead
_embedded[leads][0][id]intID do Lead
Query Params
int32

Número da página

int32

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

filter[uid]
array of strings

Filtrar pelo UID do lead de entrada. Pode ser passado um único UID ou um array de UIDs

filter[uid]
filter[category]
array of strings

Filtrar pelas categorias de leads de entrada (sip, mail, forms, chats)

filter[category]
int32

Filtrar pelo ID do pipeline

string

Ordenação dos resultados. Valores disponíveis para ordenação: asc, desc.

Responses

Language
Credentials
OAuth2
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json