Visão Geral

A API do Kommo do V4MOS.AI centraliza leads, contatos, pipelines e usuários sincronizados das contas Kommo conectadas ao seu organization. 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íveisCopiar link da seção

• getLeads/v1/kommo/leadsRetorna leads do Kommo com status, pipeline, preço, origem e timestamps do ciclo de vida.
• getContatos/v1/kommo/contactsRetorna contatos do Kommo com identificadores, campos de ciclo de vida e leads relacionados.
• getPipelines/v1/kommo/pipelinesRetorna pipelines do Kommo com estágios e metadados de status.
• getUsuários/v1/kommo/usersRetorna usuários do Kommo com função, grupo e informações de acesso.

AutenticaçãoCopiar link da seção

Todos os endpoints exigem os headers x-client-id e x-client-secret, além do query parameter organizationId. Veja Autenticação.

Parâmetros ComunsCopiar link da seção

• organizationId (obrigatório) – Organização que possui a integração Kommo
• 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 RecursoCopiar link da seção

Leads (/v1/kommo/leads)Copiar link da seção

• leadId, statusId, pipelineId, responsibleUserId, groupId
• lossReasonId
• tagId, tagName, tagColor
• tagIdFirst, tagNameFirst, tagColorFirst
• createdStart / createdEnd
• lastModifiedStart / lastModifiedEnd

Contatos (/v1/kommo/contacts)Copiar link da seção

• createdStart / createdEnd
• lastModifiedStart / lastModifiedEnd

Pipelines (/v1/kommo/pipelines)Copiar link da seção

• pipelineName, pipelineId
• statusId, statusName
• sort, color, type

Usuários (/v1/kommo/users)Copiar link da seção

• userId

Destaques do Modelo de Dados KommoCopiar link da seção

LeadsCopiar link da seção

• Identificação: lead_id, 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
• Origem: source_id, source_name
• Relacionamentos: contacts_ids
• Metadados: loss_reason_id, source_id, source_name

ContatosCopiar link da seção

• Perfil: id, email
• 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

PipelinesCopiar link da seção

• Identificação: pipeline_id, pipeline_name
• Status: status_id, status_name, pipeline_sort, sort
• Configuração: color, type, is_editable

UsuáriosCopiar link da seção

• Identidade: user_id, lang
• Acesso: rights, is_admin, is_active, is_free
• Organização: group_id, role_id

RespostasCopiar link da seção

Todas as respostas seguem o padrão:

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