Visão geral

A API CRM V4 do V4MOS.AI expõe dados de leads, oportunidades, empresas, contatos e pipelines sincronizados do CRM V4 (mars-sales) conectado à sua organização. Os endpoints compartilham o prefixo /v1/crm-v4 e usam a mesma autenticação, paginação e envelope de metadados das demais integrações do V4MOS.AI.

Endpoints disponíveisCopiar link da seção

• getLeads/v1/crm-v4/leadsRetorna leads do CRM V4 com etapa, temperatura, responsável e timestamps do ciclo de vida.
• getOportunidades/v1/crm-v4/opportunitiesRetorna oportunidades do CRM V4 com etapa, valor do deal, responsável e timestamps do ciclo de vida.
• getEmpresas/v1/crm-v4/companiesRetorna empresas do CRM V4 com segmento, faixa de receita, responsável e dados de atividade.
• getContatos/v1/crm-v4/contactsRetorna contatos do CRM V4 com sua empresa principal e responsável.
• getPipelines/v1/crm-v4/pipelinesRetorna as etapas de pipeline do CRM V4 — uma linha por par board/coluna, ordenadas por board e posição da etapa.

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 dona da integração CRM V4
• integrationId – Escopo da integração
• page – Número da página (padrão: 1)
• limit – Registros por página (padrão: 500, máx: 5000)

Filtros por recursoCopiar link da seção

Leads (/v1/crm-v4/leads)Copiar link da seção

• boardId, columnId, phaseType – Filtros de pipeline e etapa
• temperature, ownerId
• createdStart / createdEnd – Intervalo de data de criação

Oportunidades (/v1/crm-v4/opportunities)Copiar link da seção

• boardId, columnId, phaseType – Filtros de pipeline e etapa
• type – Tipo do board (OPPORTUNITY, EXPANSION, ACQUISITION)
• ownerId
• createdStart / createdEnd – Intervalo de data de criação

Empresas (/v1/crm-v4/companies)Copiar link da seção

• segment, tierType, ownerId
• lastActivityStart / lastActivityEnd – Intervalo de última atividade

Contatos (/v1/crm-v4/contacts)Copiar link da seção

• companyId, ownerId

Pipelines (/v1/crm-v4/pipelines)Copiar link da seção

• boardId
• boardType – Tipo do board (LEAD, OPPORTUNITY, EXPANSION, ACQUISITION)

Trabalhando com etapasCopiar link da seção

A etapa de um card é descrita por column_id + column_title + phase_type. Use phase_type na lógica de negócio — é o marcador estável e independente de idioma, enquanto column_title é texto livre que a organização pode renomear a qualquer momento. Faça o join dos cards com /v1/crm-v4/pipelines por board_id + column_id para resolver a ordem das etapas (column_order).

PaginaçãoCopiar link da seção

As respostas retornam meta.page, meta.limit, meta.hasNextPage e meta.hasPreviousPage. Itere enquanto hasNextPage for true.