--- title: "Retorna os dados dos leads" method: GET path: "/leads" tags: ["Leads"] --- # Retorna os dados dos leads `GET /leads` ## Request - Base URL: `https://integracao.cvcrm.com.br/api/v1/cvdw` - URL: `https://integracao.cvcrm.com.br/api/v1/cvdw/leads` - Auth: none declared. Required headers: `email`, `token` > 🔒 **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)](https://desenvolvedor.cvcrm.com.br/docs/como-autenticar-apis-cvcrm-email-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. ## Query parameters - `pagina` integer - `registros_por_pagina` integer - `a_partir_referencia` integer - `a_partir_data_referencia` string - `ate_data_referencia` string ## Headers - `email` string, required - `token` string, required ## Response `200` Leads - object: Objeto que representa um lead. - `pagina` integer: Página atual do retorno dos registros - `registros` integer: Quantidade de registro da página, máximo 500 registros - `total_de_registros` integer: Total de registros encontrados - `total_de_paginas` integer: Total de páginas encontradas - `dados` Leads[] - `referencia` string: Código identificador do lead. - `referencia_data` string: Data de referência. - `ativo` string: Informa se o lead está ativo. - `idlead` integer: Código identificador do lead. - `idsituacao` integer: Código identificador da situação do lead. - `situacao` string: Nome da situação do lead. - `data_cad` string: Data de cadastro do lead. - `nome` string: Nome do lead. - `email` string: E-mail do lead. - `telefone` string: Telefone do lead. - `documento_cliente` string: Documento do lead. - `cep_cliente` string: CEP do lead. - `idponto_venda` integer: Código identificador do PDV vinculado ao lead. - `ponto_venda` string: Nome do PDV vinculado ao lead. - `conversao_original` string: Conversão original do lead. - `conversao_ultimo` string: Última conversão do lead. - `idempreendimento_primeiro` integer: Código identificador do primeiro empreendimento vinculado ao lead. - `empreendimento_primeiro` string: Nome do primeiro empreendimento vinculado ao lead. - `idempreendimento_ultimo` integer: Código identificador do último empreendimento vinculado ao lead. - `empreendimento_ultimo` string: Nome do último empreendimento vinculado ao lead. - `idmotivo` integer: Código identificador do motivo de escolha do lead. - `motivo` string: Motivo de escolha do lead - `idgestor` integer: Código identificador do gestor vinculado ao lead. - `gestor` string: Nome do gestor vinculado ao lead. - `idcorretor` integer: Código identificador do corretor vinculado ao lead. - `corretor` string: Nome do corretor vinculado ao lead. - `data_associacao_corretor` string: Data da associação do corretor ao lead. - `idimobiliaria` integer: Código identificador da imobiliária vinculada ao lead. - `imobiliaria` string: Nome da imobiliária vinculada ao lead. - `feedback` string: Feedback do lead. - `origem` string: Origem do lead. - `origem_ultimo` string: Última origem do lead. - `midia_ultimo` string: Última mídia vinculada ao lead. - `midia_original` string: Mídia original vinculada ao lead. - `renda_familiar` string: Renda familiar do lead. - `motivo_cancelamento` string: Nome do motivo de cancelamento do lead. - `data_cancelamento` string: Data de cancelamento do lead. - `data_ultima_interacao` string: Data da última interação do lead. - `ultima_data_conversao` string: Data da última conversão do lead - `data_reativacao` string: Data da reativação do lead. - `idsituacao_anterior` integer: Código identificador da situação anterior do lead. - `nome_situacao_anterior_lead` string: Nome da situação anterior do lead. - `descricao_motivo_cancelamento` string: Descrição do motivo de cancelamento do lead. - `submotivo_cancelamento` string: Submotivo de cancelamento do lead. - `possibilidade_venda` integer: Possibilidade de venda do lead. - `inserido_bolsao` string: Informa se o lead está inserido no bolsão. - `data_primeira_interacao_gestor` string: Data da primeira interação do gestor. - `data_primeira_interacao_corretor` string: Data da primeira interação do corretor - `score` integer: Score do lead. - `idgestor_ultimo` integer: Código identificador do último gestor vinculado ao lead. - `gestor_ultimo` string: Nome do último gestor vinculado ao lead. - `idcorretor_ultimo` integer: Código identificador do último corretor vinculado ao lead. - `corretor_ultimo` string: Nome do último corretor vinculado ao lead. - `idcorretor_penultimo` integer: Código identificador do penúltimo corretor vinculado ao lead. - `idimobiliaria_ultimo` integer: Código identificador da ultima imobiliária vinculada ao lead. - `corretor_penultimo` string: Nome do penúltimo corretor vinculado ao lead. - `nome_momento_lead` string: Nome do momento vinculado ao lead. - `novo` string: Informa se o lead não recebeu uma conversão após o cadastro. - `retorno` string: Informa se o lead recebeu uma conversão após o cadastro. - `data_ultima_alteracao` string: Data da última alteração do lead. - `estado` string: Estado do lead. - `cidade` string: Cidade do lead. - `regiao` string: Região do primeiro empreendimento vinculado ao lead. - `vencido` string: Informa se o lead está vencido. - `data_vencimento` string: Data da vencimento do lead. - `profissao` string: Profissão do lead. - `tags` string: Tag(s) vinculada(s) ao lead. - `conversao` string: Origens das conversões do lead. - `idempreendimento` string: Código identificador(es) do(s) empreendimento(s) do lead. - `codigointerno_empreendimento` string: Código(s) interno(s) do(s) empreendimento(s) do lead. - `empreendimento` string: Nome(s) do(s) empreendimento(s) vinculado(s) ao lead. - `caracteristicas` string: Característica(s) do(s) empreendimento(s) vinculado(s) ao lead. - `reserva` integer: Quantidade de reservas associadas ao lead. - `origem_nome` string: Nome da origem do lead. - `origem_ultimo_nome` string: Nome da última origem do lead. - `campos_adicionais` CamposAdicionais[] - `referencia` integer: Código identificador do campo adicional - `referencia_data` string: Data de referência - `idcampo_valores` integer: Código identificador do valor do campo adicional - `idcampo` integer: Código identificador do campo adicional - `nome` string: Descrição do campo adicional - `valor` string: Dado que foi inserido pelo usuário na funcionalidade - `tipo` string: Tipo do campo ## Other responses - `204`: Nenhum dado foi encontrado na API de leads. - `400`: Erro de solicitação da API de leads, revise os parâmetros! - `401`: E-mail e/ou token incorreto(s). - `422`: Erro inesperado na API de leads, por favor entre em contato com o suporte técnico. --- [API](https://skmtc.dev/cvcrm/apis/cvdw.md) - [All operations](https://skmtc.dev/cvcrm/apis/cvdw/llms.txt) - [OpenAPI document](https://skmtc.dev/cvcrm/apis/cvdw/revisions/ca413a559002?raw)