Leads

GET

https://api.data.v4.marketing/v1/kommo/leads

Retrieve Kommo leads with status, pipeline, tags, pricing, and lifecycle timestamps.

Filters:

workspaceId (required)

integrationId (optional)

organizationId (optional)

leadId, statusId, pipelineId

responsibleUserId, groupId

lossReasonId

tagId, tagName, tagColor

tagIdFirst, tagNameFirst, tagColorFirst

createdStart, createdEnd

lastModifiedStart, lastModifiedEnd

Requisição

Authorization

API Key

Adicionar parâmetro em header

x-client-id

Exemplo:

x-client-id: ********************

API Key

Adicionar parâmetro em header

x-client-secret

Exemplo:

x-client-secret: ********************

Parâmetros de Consulta

Respostas

🟢200

application/json

Successful response

Body

🟠400

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.data.v4.marketing/v1/kommo/leads?workspaceId=workspace_123&integrationId&organizationId&leadId&statusId&responsibleUserId&groupId&pipelineId&lossReasonId&tagId&tagName&tagColor&tagIdFirst&tagNameFirst&tagColorFirst&createdStart=2026-01-01T00:00:00Z&createdEnd=2026-01-31T23:59:59Z&lastModifiedStart=2026-01-01T00:00:00Z&lastModifiedEnd=2026-01-31T23:59:59Z&page&limit' \
--header 'x-client-id: <api-key>' \
--header 'x-client-secret: <api-key>'

Response Example

200 - Exemplo 1

{
    "data": [
        {
            "lead_id": "string",
            "lead_name": "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:22.123Z",
            "updated_at": "2019-08-24T14:15:22.123Z",
            "closed_at": "2019-08-24T14:15:22.123Z",
            "closest_task_at": "2019-08-24T14:15:22.123Z",
            "is_deleted": true,
            "custom_fields_values": "string",
            "score": "string",
            "account_id": "string",
            "labor_cost": 0,
            "source_id": "string",
            "source_name": "string",
            "tags": "string",
            "contacts_ids": "string",
            "loss_reason": "string",
            "tag_id": "string",
            "tag_name": "string",
            "tag_color": "string",
            "tag_id_first": "string",
            "tag_name_first": "string",
            "tag_color_first": "string",
            "integration_id": "string",
            "workspace_id": "string",
            "organization_id": "string",
            "document_id": "string",
            "inserted_at": "2019-08-24T14:15:22.123Z"
        }
    ],
    "meta": {
        "page": 0,
        "limit": 0,
        "hasNextPage": true,
        "hasPreviousPage": true
    }
}

Modificado em 2026-01-27 12:24:45