Buscar Prospects

Descrição

Endpoint para consultar prospects com filtros variados e paginação.

🔑 Parâmetros de consulta (Query Params)

Parâmetro	Tipo	Obrigatório	Descrição
idProspect	int32	Não	ID do prospect
name	string	Não	Nome do prospect
document	string	Não	Documento do prospect
email	string	Não	Email do prospect
phone	string	Não	Telefone/celular do prospect
registerDateStart	date-time	Não	Data inicial para filtro de registro
registerDateEnd	date-time	Não	Data final para filtro de registro
conversionDateStart	date-time	Não	Data inicial para filtro de data de conversão
conversionDateEnd	date-time	Não	Data final para filtro de data de conversão
take	int32	Não	Total de registros a retornar (máximo 50). Default: 50
skip	int32	Não	Total de registros para pular (offset). Default: 0
gympassId	string	Não	ID do Gympass do prospect

📤 Estrutura da Resposta
A resposta retorna uma lista de prospects cadastrados, contendo informações pessoais, dados de contato, origem do cadastro, status de conversão, interesses e responsáveis financeiros.

Campo	Tipo	Descrição
`idProspect`	int32	Identificador único do prospect.
`idBranch`	int32	ID da filial onde o prospect foi registrado.
`branchName`	string	Nome da filial associada ao prospect.
`firstName`	string	Primeiro nome do prospect.
`lastName`	string	Sobrenome do prospect.
`registerName`	string	Nome informado no momento do cadastro.
`registerLastName`	string	Sobrenome informado no momento do cadastro.
`usePreferredName`	boolean	Indica se o prospect utiliza nome preferencial.
`document`	string	Documento principal do prospect (ex.: CPF).
`rg`	string	Registro Geral (RG) do prospect.
`cellphone`	string	Número de telefone celular.
`email`	string	Endereço de e-mail do prospect.
`gympassId`	string	Identificador do prospect em plataformas parceiras (ex.: Gympass).
`registerDate`	date-time	Data de registro do prospect.
`gender`	string	Gênero informado pelo prospect.
`birthDate`	date-time	Data de nascimento do prospect.
`signupType`	string	Tipo de cadastro realizado (ex.: presencial, online, campanha).
`mktChannel`	string	Canal de marketing de origem do prospect.
`conversionDate`	date-time	Data de conversão do prospect em aluno, se aplicável.
`idMember`	int32	ID do membro associado após conversão.
`currentStep`	string	Etapa atual do funil de relacionamento/comercial.
`address`	string	Endereço do prospect.
`city`	string	Cidade do endereço.
`complement`	string	Complemento do endereço.
`neighborhood`	string	Bairro do endereço.
`state`	string	Estado do endereço.
`country`	string	País do endereço.
`zipCode`	string	CEP / Código postal.
`number`	string	Número do endereço.
`temperature`	string	Classificação de interesse do prospect (ex.: frio, morno, quente).
`notes`	string	Observações adicionais sobre o prospect.
`interests`	array	Lista de interesses informados pelo prospect.
`financiallyResponsibles`	array	Responsáveis financeiros associados ao prospect. Ver mais abaixo.

🧩 Estrutura de `financiallyResponsibles`

Campo	Tipo	Descrição
`idMember`	int32	Identificador do membro responsável financeiramente.
`name`	string	Nome do responsável financeiro.
`email`	string	E-mail do responsável financeiro.
`cpf`	string	CPF do responsável financeiro.

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

Authorization: Basic *****************

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200OK

application/json

Success

Body

Exemplo

[
    {
        "idProspect": 0,
        "idBranch": 0,
        "branchName": "string",
        "firstName": "string",
        "lastName": "string",
        "registerName": "string",
        "registerLastName": "string",
        "usePreferredName": true,
        "document": "string",
        "rg": "string",
        "cellphone": "string",
        "email": "string",
        "gympassId": "string",
        "registerDate": "2019-08-24T14:15:22.123Z",
        "gender": "string",
        "birthDate": "2019-08-24T14:15:22.123Z",
        "signupType": "string",
        "mktChannel": "string",
        "conversionDate": "2019-08-24T14:15:22.123Z",
        "idMember": 0,
        "currentStep": "string",
        "address": "string",
        "city": "string",
        "complement": "string",
        "neighborhood": "string",
        "state": "string",
        "country": "string",
        "zipCode": "string",
        "number": "string",
        "temperature": "string",
        "notes": "string",
        "interests": [
            "string"
        ],
        "financiallyResponsibles": [
            {
                "idMember": 0,
                "name": "string",
                "email": "string",
                "cpf": "string"
            }
        ]
    }
]

🟠400Bad Request

Get prospects