Visão geral

A API Salesforce da V4MOS.AI entrega os registros brutos sincronizados das contas Salesforce conectadas à sua organização: oportunidades, histórico de oportunidades, fases de oportunidade, leads e contatos. 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/salesforce 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 Salesforce 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/salesforce/opportunities?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/salesforce/opportunitiesUma linha por oportunidade: fase, valor, probabilidade, data de fechamento, indicadores de fechada/ganha, conta, contato, campanha e…
• getHistórico de oportunidades/v1/salesforce/opportunity-historyUma linha por alteração registrada em uma oportunidade: fase, valor, probabilidade e data de fechamento depois da alteração.
• getFases de oportunidade/v1/salesforce/opportunity-stagesUma linha por fase de oportunidade configurada na org: rótulo, ordem, indicadores de fechada/ganha e probabilidade padrão.
• getLeads/v1/salesforce/leadsUma linha por lead: status, origem e conversão (data, contato e oportunidade).
• getContatos/v1/salesforce/contactsUma linha por contato, com a conta e a origem do lead.

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.