Overview

A API do Kommo do V4 Marketing centraliza leads, contatos, pipelines e usuários sincronizados das contas Kommo conectadas ao seu workspace. Todos os endpoints ficam sob o prefixo /v1/kommo e seguem os mesmos padrões de autenticação, paginação e resposta da plataforma.

Endpoints Disponíveis

Leads

GET /v1/kommo/leads – Leads com status, pipeline, tags, valores e datas do ciclo de vida

Contatos

GET /v1/kommo/contacts – Contatos com dados de perfil, campos customizados e vínculos com leads

Pipelines

GET /v1/kommo/pipelines – Etapas do funil e metadados de status

Usuários

GET /v1/kommo/users – Usuários do Kommo com grupos, permissões e funções

Autenticação

Inclua as credenciais em todas as requisições através dos cabeçalhos HTTP obrigatórios:

Parâmetros Comuns

workspaceId (obrigatório) – Workspace que possui a integração Kommo

organizationId – Escopo de organização

integrationId – ID da integração

page – Número da página (padrão: 1)

limit – Registros por página (padrão: 500, máx: 5000)

createdStart / createdEnd – Filtro por data de criação

lastModifiedStart / lastModifiedEnd – Filtro por data da última modificação

Filtros Específicos por Recurso

Leads (`/v1/kommo/leads`)

leadId, statusId, pipelineId, responsibleUserId, groupId

lossReasonId

tagId, tagName, tagColor

tagIdFirst, tagNameFirst, tagColorFirst

createdStart / createdEnd

lastModifiedStart / lastModifiedEnd

Contatos (`/v1/kommo/contacts`)

createdStart / createdEnd

lastModifiedStart / lastModifiedEnd

Pipelines (`/v1/kommo/pipelines`)

pipelineName, pipelineId

statusId, statusName

sort, color, type

Usuários (`/v1/kommo/users`)

userId

Destaques do Modelo de Dados Kommo

Leads

Identificação: lead_id, lead_name, pipeline_id, status_id

Responsáveis e valor: responsible_user_id, group_id, price, labor_cost

Ciclo de vida: created_at, updated_at, closed_at, inserted_at

Tags e origem: tags, tag_id, tag_name, tag_color, tag_id_first

Relacionamentos: contacts_ids

Metadados: loss_reason_id, loss_reason, source_id, source_name

Contatos

Perfil: name, first_name, last_name, email, phone, treated_phone

Responsáveis: responsible_user_id, group_id

Ciclo de vida: created_at, updated_at, closest_task_at, inserted_at

Flags: is_deleted, is_unsorted

Relacionamentos: id_leads

Dados customizados: custom_fields_values

Pipelines

Identificação: pipeline_id, pipeline_name

Status: status_id, status_name, pipeline_sort, sort

Configuração: color, type, is_editable

Usuários

Identidade: user_id, user_name, user_email, lang

Acesso: rights, is_admin, is_active, is_free

Organização: group_id, role_id

Respostas

Todas as respostas seguem o padrão:

{
  "data": [...],
  "meta": {
    "page": 1,
    "limit": 500,
    "hasNextPage": true,
    "hasPreviousPage": false
  }
}

Endpoints Disponíveis#

Leads#

Contatos#

Pipelines#

Usuários#

Autenticação#

Parâmetros Comuns#

Filtros Específicos por Recurso#

Leads (/v1/kommo/leads)#

Contatos (/v1/kommo/contacts)#

Pipelines (/v1/kommo/pipelines)#

Usuários (/v1/kommo/users)#

Destaques do Modelo de Dados Kommo#

Leads#

Contatos#

Pipelines#

Usuários#

Respostas#

Endpoints Disponíveis

Leads

Contatos

Pipelines

Usuários

Autenticação

Parâmetros Comuns

Filtros Específicos por Recurso

Leads (`/v1/kommo/leads`)

Contatos (`/v1/kommo/contacts`)

Pipelines (`/v1/kommo/pipelines`)

Usuários (`/v1/kommo/users`)

Destaques do Modelo de Dados Kommo

Leads

Contatos

Pipelines

Usuários

Respostas