v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Leads

Retorna a listagem de interações dos leads.

🔒 Autenticação necessária

Esta API utiliza autenticação via e-mail e token nos headers da requisição. Consulte o tutorial completo antes de fazer sua primeira chamada: Como autenticar nas APIs do CV CRM (v1 — E-mail e Token)

Esta api retorna a listagem de interações dos leads.

get/leads/interacoes

Query parameters

paginainteger

Página que deseja visualizar os registros

registros_por_paginainteger

Quantidade de registro por página, máximo 500 registros

a_partir_referenciainteger

Retornará os registros a partir deste id, lembrando que está ordenado por referencia_data.

a_partir_data_referenciastring

Retornará os registros com data referência a partir da data informada

ate_data_referenciastring

Retornará os registros com data referência até a data informada

Headers

emailstring required

E-mail de autenticação do usuário administrativo

tokenstring required

Token criado no usuário administrativo do e-mail

Response

Leads Interações

paginainteger

Página atual do retorno dos registros

registrosinteger

Quantidade de registro da página, máximo 500 registros

total_de_registrosinteger

Total de registros encontrados

total_de_paginasinteger

Total de páginas encontradas

Example response

{
  "pagina": 1,
  "registros": 30,
  "total_de_registros": 1054,
  "total_de_paginas": 36,
  "dados": [
    {
      "referencia": "193",
      "referencia_data": "2023-01-15 15:26:15",
      "ativo": "S",
      "idinteracao": 193,
      "idlead": 168523,
      "data_cad": "2022-03-06 10:00:00",
      "tipo": "L",
      "descricao": "Ligação para o Lead as 12:00h (TEXT)",
      "situacao": "A",
      "enviar_corretor": "S",
      "enviar_imobiliaria": "N",
      "enviar_cliente": "N",
      "idimobiliaria": 274,
      "imobiliaria": "IMOBILIÁRIA QC",
      "idcorretor": 274,
      "corretor": "CORRETOR QC",
      "idgestor": 144,
      "gestor_interacao": "Nome do Gestor",
      "corretor_interacao": "Nome do Corretor",
      "imobiliaria_interacao": "Nome do Usuário Imobiliária",
      "whatsapp_respondido": "S",
      "ultimo_retorno": "Whatsapp respondido"
    }
  ]
}