Sign in

v1

latestOpenAPI 3.1.02026-07-261620662.2 KB

Lista de Leads de entrada

Este método permite obter uma lista de leads de entrada existentes na conta

get/api/v4/leads/unsorted

Query parameters

pageinteger

Número da página

limitinteger

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

filter[uid]string[]

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

filter[category]string[]

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

filter[pipeline_id]integer

Filtrar pelo ID do pipeline

order[created_at]string

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

Response

200

_pageinteger

Example response

{
  "_page": 1,
  "_links": {
    "self": {
      "href": "https://devteam.kommo.com/api/v4/leads/unsorted"
    }
  },
  "_embedded": {
    "unsorted": [
      {
        "uid": "5af9dedb6f2c6a29eaac6ee37fc75ffbb66e139e4603bdd0e14e39d4b319",
        "category": "forms",
        "pipeline_id": 6950551,
        "created_at": 1686819152,
        "metadata": {
          "form_id": "1115559",
          "form_name": "Form #1686818993",
          "form_page": "Solicitação do site #1115559 do formulário «Formulário #1686818993»",
          "ip": "212.46.197.210",
          "form_sent_at": "1686819152",
          "referer": "https://devteam.kommo.com/"
        },
        "account_id": 31361463,
        "_links": {
          "self": {
            "href": "LINK"
          }
        },
        "_embedded": {
          "contacts": [
            {
              "id": 583338,
              "_links": {
                "self": {
                  "href": "https://devteam.kommo.com/api/v4/contacts/583338"
                }
              }
            }
          ],
          "leads": [
            {
              "id": 236768,
              "_links": {
                "self": {
                  "href": "https://devteam.kommo.com/api/v4/leads/236768"
                }
              }
            }
          ]
        }
      }
    ]
  }
}