v1

latestOpenAPI 3.0.02026-07-264636241.7 MB
Leads

Retorna os dados 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 os dados dos leads a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.

get/leads

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

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 ou 193_30",
      "referencia_data": "2023-01-15 15:26:15",
      "ativo": "S",
      "idlead": 193,
      "idsituacao": 4,
      "situacao": "Descartado",
      "data_cad": "2022-03-06 10:00:00",
      "nome": "Saulo Nunes",
      "email": "importacao_nandes2.3@hotmail.com",
      "telefone": "31984658621",
      "documento_cliente": "09809809812",
      "cep_cliente": "49010020",
      "idponto_venda": 2,
      "ponto_venda": "Ponto das vendas",
      "conversao_original": "Facebook",
      "conversao_ultimo": "Facebook",
      "idempreendimento_primeiro": 3,
      "empreendimento_primeiro": "Varandas",
      "idempreendimento_ultimo": 217,
      "empreendimento_ultimo": "Alpha",
      "idmotivo": 1,
      "motivo": "Localização",
      "idgestor": 144,
      "gestor": "Henrique",
      "idcorretor": 6017,
      "corretor": "Matheus",
      "data_associacao_corretor": "2022-03-06 12:09:11",
      "idimobiliaria": 2,
      "imobiliaria": "Qualidade",
      "feedback": "Interessado",
      "origem": "CH",
      "origem_ultimo": "FB",
      "midia_ultimo": "Facebook Ads",
      "midia_original": "Formulário Site",
      "renda_familiar": "10000.00",
      "motivo_cancelamento": "Outra escolha",
      "data_cancelamento": "2022-06-21",
      "data_ultima_interacao": "2022-03-06 10:00:00",
      "ultima_data_conversao": "2022-03-06 10:03:26",
      "data_reativacao": "2022-07-06 11:08:34",
      "idsituacao_anterior": 1,
      "nome_situacao_anterior_lead": "Sem contato",
      "descricao_motivo_cancelamento": "Preferiu outro empreendimento",
      "submotivo_cancelamento": "Cancelamento em lote",
      "possibilidade_venda": 4,
      "inserido_bolsao": "S",
      "data_primeira_interacao_gestor": "2022-03-06 12:09:11",
      "data_primeira_interacao_corretor": "2022-03-06 17:09:29",
      "score": 100,
      "idgestor_ultimo": 13,
      "gestor_ultimo": "Alberto",
      "idcorretor_ultimo": 6023,
      "corretor_ultimo": "Kelly",
      "idcorretor_penultimo": 6099,
      "idimobiliaria_ultimo": 3,
      "corretor_penultimo": "Liliane",
      "nome_momento_lead": "Interessado",
      "novo": "S",
      "retorno": "N",
      "data_ultima_alteracao": "2023-06-21 08:25:48",
      "estado": "SE",
      "cidade": "Aracaju",
      "regiao": "Nordeste",
      "vencido": "S",
      "data_vencimento": "2022-06-21 08:25:48",
      "profissao": "Desenvolvedor(a)",
      "tags": "Interessado, integracao",
      "conversao": "CH;FB",
      "idempreendimento": "3",
      "codigointerno_empreendimento": "856320",
      "empreendimento": "Varandas;Alpha",
      "caracteristicas": "3 quartos;Piscina",
      "reserva": 1,
      "origem_nome": "Chat Online",
      "origem_ultimo_nome": "Facebook",
      "campos_adicionais": [
        {
          "referencia": 193,
          "referencia_data": "2023-12-29 16:12:52",
          "idcampo_valores": 12414,
          "idcampo": 312,
          "nome": "CONTRATO - USO",
          "valor": "valor informado pelo usuário",
          "tipo": "texto"
        }
      ]
    }
  ]
}