get https://evo-integracao-api.w12app.com.br/api/v1/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â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 |
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 |
Resposta
Retorna uma lista de objetos prospect com os seguintes campos:
Parâmetro | Tipo | Descrição |
---|---|---|
idProspect | int | ID do prospect |
idBranch | int | ID da unidade/filial |
branchName | string | Nome da unidade/filial |
firstName | string | Primeiro nome do prospect |
lastName | string | Sobrenome do prospect |
document | string | Documento do prospect |
cellphone | string | Número de celular do prospect |
string | Email do prospect | |
gympassId | string | ID do Gympass do prospect |
registerDate | date-time | Data de registro do prospect |
gender | string | Gênero |
birthDate | date-time | Data de nascimento |
signupType | string | Tipo de cadastro |
mktChannel | string | Canal de marketing |
conversionDate | date-time | Data de conversão para membro |
idMember | int | ID do membro associado ao prospect (se houver) |
currentStep | string | Etapa atual do prospect |
address | string | Endereço completo |
city | string | Cidade |
complement | string | Complemento do endereço |
neighborhood | string | Bairro |
state | string | Estado |
country | string | País |
zipCode | string | Código postal |
number | string | Número residencial |
Objeto responsável (responsible)
Parâmetro | Tipo | Descrição |
---|---|---|
name | string | Nome do responsável |
document | string | Documento do responsável |
financialResponsible | boolean | Indica se é responsável financeiro |