Visão geral

A API Bitrix24 da V4MOS.AI entrega os registros brutos sincronizados das contas Bitrix24 conectadas à sua organização: negócios, leads, contatos, histórico de fases dos negócios e de status dos leads, funis e status. 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/bitrix24 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 Bitrix24 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/bitrix24/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/bitrix24/dealsUma linha por negócio: funil (categoria), fase, valor, moeda, fonte, UTMs, contatos, empresa, responsável e data de fechamento.
• getLeads/v1/bitrix24/leadsUma linha por lead: status, fonte, UTMs, contato, empresa, responsável e valor.
• getContatos/v1/bitrix24/contactsUma linha por contato: fonte, UTMs, empresa e responsável.
• getHistórico de fases dos negócios/v1/bitrix24/deal-stage-historyUma linha por mudança de fase de um negócio: nova fase, a semântica dela (em andamento, ganho, perdido) e o funil.
• getHistórico de status dos leads/v1/bitrix24/lead-status-historyUma linha por mudança de status de um lead: novo status e a semântica dele.
• getFunis/v1/bitrix24/pipelinesUma linha por funil de negócios (categoria), com a ordem e o indicador de funil padrão.
• getStatus/v1/bitrix24/statusesUma linha por status de uma entidade do CRM (fases de negócio, status de lead, fontes...), com a semântica e o funil.

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.