Buscar Prospects

Descrição

Este endpoint retorna a lista de prospects cadastrados dentro de um período específico. Ele fornece informações sobre cadastro, visitas, conversão em clientes, detalhes de contato e origem de marketing.

🔑 Parâmetros da Requisição (Query Param)

Parâmetro	Tipo	Obrigatório	Descrição
dtStart	string(date-time)	Sim	Data inicial do período a ser consultado.
dtEnd	string(date-time)	Sim	Data final do período a ser consultado.

📤 Estrutura da Resposta

A resposta retorna uma lista de prospects com informações detalhadas sobre cadastro, visitas, conversão e contatos.

Campo	Tipo	Descrição
idFilial	int32	Identificador da filial do prospect.
nomeFilial	string	Nome da filial.
status	string	Status atual do prospect (ex.: "Novo", "Convertido").
idProspect	int32	Identificador do prospect.
nome	string	Nome do prospect.
dtCadastro	string(date-time)	Data de cadastro do prospect.
primeiraVisita	string	Data ou descrição da primeira visita do prospect.
convertidoPor	string	Nome do colaborador que converteu o prospect em cliente, se aplicável.
dtConversao	string(date-time)	Data de conversão em cliente, se aplicável.
idCliente	int32	ID do cliente convertido, se aplicável.
descricao	string	Observações ou descrição do prospect.
primeiroContrato	string	Informações sobre o primeiro contrato realizado pelo prospect convertido.
apelido	string	Apelido ou nome reduzido do prospect.
marketing	string	Origem ou campanha de marketing vinculada ao prospect.
emailAtual	string	Email de contato atual do prospect.
celularAtual	string	Telefone celular de contato atual.

✅ Exemplo de Resposta

[
  {
    "idFilial": 10,
    "nomeFilial": "Filial Centro",
    "status": "Convertido",
    "idProspect": 5001,
    "nome": "Ana Pereira",
    "dtCadastro": "2025-09-01T09:30:00Z",
    "primeiraVisita": "2025-09-05",
    "convertidoPor": "Carlos Silva",
    "dtConversao": "2025-09-10T14:45:00Z",
    "idCliente": 12345,
    "descricao": "Interessada em plano anual",
    "primeiroContrato": "Plano Anual Premium",
    "apelido": "Ana P.",
    "marketing": "Campanha Redes Sociais",
    "emailAtual": "[email protected]",
    "celularAtual": "+5511988887777"
  }
]