Kommo

Leads

GET
/v1/kommo/leads

Retorna leads do Kommo com status, pipeline, preço, origem e timestamps do ciclo de vida.

Filtros:

  • organizationId (obrigatório)
  • integrationId (opcional)
  • leadId, statusId, pipelineId
  • responsibleUserId, groupId
  • lossReasonId
  • createdStart, createdEnd
  • lastModifiedStart, lastModifiedEnd

Autorização

ClientIdAuthClientSecretAuth
headerx-client-id<token>

Client ID

headerx-client-secret<token>

Client secret

Parâmetros de query

organizationId*string

Identificador da organização (obrigatório)

integrationId?string

Identificador da integração (opcional)

leadId?string

Identificador do lead (opcional)

statusId?string

Identificador do status (opcional)

responsibleUserId?string

Identificador do usuário responsável (opcional)

groupId?string

Identificador do grupo (opcional)

pipelineId?string

Identificador do pipeline (opcional)

lossReasonId?string

Identificador do motivo de perda (opcional)

createdStart?string

Data/hora inicial para filtragem (opcional, formato ISO 8601)

Formatodate-time
createdEnd?string

Data/hora final para filtragem (opcional, formato ISO 8601)

Formatodate-time
lastModifiedStart?string

Data/hora inicial para filtro de última atualização (opcional, formato ISO 8601)

Formatodate-time
lastModifiedEnd?string

Data/hora final para filtro de última atualização (opcional, formato ISO 8601)

Formatodate-time
page?integer

Número da página para paginação (opcional)

Padrão1
limit?integer

Número de itens por página (opcional, máx. 5000)

Intervalovalue <= 5000
Padrão500

Corpo da resposta

Resposta de sucesso

application/json
  1. response
data?array<>
meta?
curl -X GET "https://example.com/v1/kommo/leads?organizationId=organization_123&createdStart=2026-01-01T00%3A00%3A00Z&createdEnd=2026-01-31T23%3A59%3A59Z&lastModifiedStart=2026-01-01T00%3A00%3A00Z&lastModifiedEnd=2026-01-31T23%3A59%3A59Z"
{  "data": [    {      "lead_id": "string",      "status_id": "string",      "price": 0,      "responsible_user_id": "string",      "group_id": "string",      "pipeline_id": "string",      "loss_reason_id": "string",      "created_by": "string",      "updated_by": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "closed_at": "2019-08-24T14:15:22Z",      "closest_task_at": "2019-08-24T14:15:22Z",      "is_deleted": true,      "score": "string",      "account_id": "string",      "labor_cost": 0,      "source_id": "string",      "source_name": "string",      "contacts_ids": "string",      "integration_id": "string",      "organization_id": "string",      "document_id": "string",      "inserted_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "page": 0,    "limit": 0,    "hasNextPage": true,    "hasPreviousPage": true  }}