Visão geral

A API Pipedrive da V4MOS.AI entrega os registros brutos sincronizados das contas Pipedrive conectadas à sua organização: negócios, histórico de etapas dos negócios, leads, pessoas, funis, etapas, usuários e definições de campos. 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/pipedrive 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 Pipedrive 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/pipedrive/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

• getNegócios/v1/pipedrive/dealsUma linha por negócio: funil, etapa, status, valor, datas de ganho/perda/fechamento, pessoa, organização, responsável, origem e canal.
• getHistórico de etapas dos negócios/v1/pipedrive/deal-stage-historyUma linha por alteração de um campo acompanhado do negócio (como a etapa): valor antigo e novo, quando e por quem.
• getLeads/v1/pipedrive/leadsUma linha por lead da Caixa de entrada de leads: responsável, pessoa, organização, fonte, origem, canal, valor e previsão de fechamento.
• getPessoas/v1/pipedrive/personsUma linha por pessoa (contato), com o responsável e a organização.
• getFunis/v1/pipedrive/pipelinesUma linha por funil, com a ordem e a configuração de probabilidade dos negócios.
• getEtapas/v1/pipedrive/stagesUma linha por etapa do funil: ordem, probabilidade dos negócios e configuração de negócios parados.
• getUsuários/v1/pipedrive/usersUma linha por usuário da conta, com os indicadores de ativo e administrador.
• getFontes de lead/v1/pipedrive/lead-sourcesUma linha por nome de fonte de lead disponível na conta.
• getCampos de negócio/v1/pipedrive/deal-fieldsUma linha por definição de campo de negócio (padrão ou personalizado), com as opções (JSON).
• getCampos de pessoa/v1/pipedrive/person-fieldsUma linha por definição de campo de pessoa (padrão ou personalizado), com as opções (JSON).

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.