Get prospects

Descrição

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

Requisição

GET https://evo-integracao-api.w12app.com.br/api/v1/prospects

Parâmetros de consulta (query params)

ParâmetroTipoObrigatórioDescrição
idProspectint32NãoID do prospect
namestringNãoNome do prospect
documentstringNãoDocumento do prospect
emailstringNãoEmail do prospect
phonestringNãoTelefone/celular do prospect
registerDateStartdate-timeNãoData inicial para filtro de registro
registerDateEnddate-timeNãoData final para filtro de registro
conversionDateStartdate-timeNãoData inicial para filtro de data de conversão
conversionDateEnddate-timeNãoData final para filtro de data de conversão
takeint32NãoTotal de registros a retornar (máximo 50). Default: 50
skipint32NãoTotal de registros para pular (offset). Default: 0
gympassIdstringNãoID do Gympass do prospect

Resposta

Retorna uma lista de objetos prospect com os seguintes campos:

ParâmetroTipoDescrição
idProspectintID do prospect
idBranchintID da unidade/filial
branchNamestringNome da unidade/filial
firstNamestringPrimeiro nome do prospect
lastNamestringSobrenome do prospect
documentstringDocumento do prospect
cellphonestringNúmero de celular do prospect
emailstringEmail do prospect
gympassIdstringID do Gympass do prospect
registerDatedate-timeData de registro do prospect
genderstringGênero
birthDatedate-timeData de nascimento
signupTypestringTipo de cadastro
mktChannelstringCanal de marketing
conversionDatedate-timeData de conversão para membro
idMemberintID do membro associado ao prospect (se houver)
currentStepstringEtapa atual do prospect
addressstringEndereço completo
citystringCidade
complementstringComplemento do endereço
neighborhoodstringBairro
statestringEstado
countrystringPaís
zipCodestringCódigo postal
numberstringNúmero residencial

Objeto responsável (responsible)

ParâmetroTipoDescrição
namestringNome do responsável
documentstringDocumento do responsável
financialResponsiblebooleanIndica se é responsável financeiro

Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!