Visão geral

A API PipeRun da V4MOS.AI entrega os registros brutos sincronizados das contas PipeRun conectadas à sua organização: oportunidades, histórico de etapas, pessoas, empresas, funis, etapas, origens, motivos de perda, usuários e oportunidades excluídas. As linhas vêm como foram sincronizadas, com os nomes de coluna do data warehouse (snake_case), prontas para levar ao seu BI. Todos os endpoints usam o prefixo /v1/piperun e seguem a mesma autenticação, paginação e formato de resposta.

Primeiros passosCopiar link da seção

URL base: https://data.v4mos.ai. Toda chamada exige suas credenciais de API e o organizationId — veja Autenticação.

1. Conecte a integração PipeRun em app.v4mos.ai (Contas conectadas) e aguarde a primeira sincronização.
2. Chame qualquer endpoint abaixo com o seu organizationId, por exemplo GET /v1/piperun/deals?organizationId=….
3. Toda linha traz integration_id e integration_name: a conta conectada de onde ela veio. Para ler uma conta só, passe esse valor em integrationId.

Endpoints disponíveisCopiar link da seção

• getOportunidades/v1/piperun/dealsUma linha por oportunidade: funil, etapa, status, valor, MRR, temperatura, probabilidade, pessoa, empresa, origem, motivo de perda e datas…
• getHistórico de etapas/v1/piperun/deal-stage-historyUma linha por permanência de uma oportunidade em uma etapa: datas de entrada e saída, usuários e valores.
• getPessoas/v1/piperun/personsUma linha por pessoa (contato): responsável, gestor, status e quando virou cliente.
• getEmpresas/v1/piperun/companiesUma linha por empresa: responsável, gestor, segmento, status e indicadores de cliente e fornecedor.
• getFunis/v1/piperun/pipelinesUma linha por funil: tipo de funil, ordem e indicador de funil principal.
• getEtapas/v1/piperun/stagesUma linha por etapa do funil: ordem, percentual de conclusão e permissões de ganhar e criar oportunidades.
• getOrigens/v1/piperun/originsUma linha por origem de oportunidade, com o grupo de origens.
• getGrupos de origens/v1/piperun/origin-groupsUma linha por grupo de origens de oportunidade.
• getMotivos de perda/v1/piperun/lost-reasonsUma linha por motivo de perda de oportunidade.
• getUsuários/v1/piperun/usersUma linha por usuário da conta: indicador de ativo e funil padrão.
• getOportunidades excluídas/v1/piperun/deleted-dealsUma linha por oportunidade excluída no PipeRun; use para remover essas oportunidades da sua cópia.

RecursosCopiar link da seção

Paginação e filtrosCopiar link da seção

• page (padrão 1) e limit (padrão 500, máximo 5000). meta.hasNextPage diz se existe outra página; as linhas vêm sempre na mesma ordem, então avance as páginas até ele ser false.
• dateFrom / dateTo (YYYY-MM-DD, inclusivos) filtram pela coluna de data indicada na tabela acima. Recursos sem coluna de data recusam esses parâmetros.
• integrationId mantém só as linhas de uma conta conectada.
• As respostas ficam em cache por 30 minutos e os dados são sincronizados uma vez por dia — veja Sincronização de dados.

Formato da respostaCopiar link da seção

{
  "data": [{ "...": "um objeto por linha, com as colunas listadas em cada endpoint" }],
  "meta": {
    "page": 1,
    "limit": 500,
    "hasNextPage": true,
    "hasPreviousPage": false
  }
}

Valores monetários e contadores grandes (campos format: decimal e format: int64 no schema de cada endpoint) chegam como texto, por exemplo "125.50", para não perder precisão. Converta para um tipo decimal do seu lado.