Get prospects
GET
https://evo-integracao-api.w12app.com.br/api/v1/prospects
🌐 API Reference/Prospects
Buscar Prospects
Descripción
Endpoint para consultar prospects con filtros variados y paginación.
OBS. Disponible para uso con clave de acceso de sucursal y también con clave de acceso de ADM General.
🔑 Parámetros de Consulta (Query Params)
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| idProspect | int32 | No | ID del prospect |
| name | string | No | Nombre del prospect |
| document | string | No | Documento del prospect |
| string | No | Correo electrónico del prospect | |
| phone | string | No | Teléfono/celular del prospect |
| registerDateStart | date-time | No | Fecha inicial para filtro de registro |
| registerDateEnd | date-time | No | Fecha final para filtro de registro |
| conversionDateStart | date-time | No | Fecha inicial para filtro de fecha de conversión |
| conversionDateEnd | date-time | No | Fecha final para filtro de fecha de conversión |
| take | int32 | No | Total de registros a devolver (máximo 50). Predeterminado: 50 |
| skip | int32 | No | Total de registros a omitir (offset). Predeterminado: 0 |
| gympassId | string | No | ID del Gympass del prospect |
📤 Estructura de la Respuesta
La respuesta devuelve una lista de prospects registrados, incluyendo información personal, datos de contacto, origen del registro, estado de conversión, intereses y responsables financieros.
| Campo | Tipo | Descripción |
|---|---|---|
idProspect | int32 | Identificador único del prospect. |
idBranch | int32 | ID de la sucursal donde se registró el prospect. |
branchName | string | Nombre de la sucursal asociada al prospect. |
firstName | string | Primer nombre del prospect. |
lastName | string | Apellido del prospect. |
registerName | string | Nombre registrado al momento de la inscripción. |
registerLastName | string | Apellido registrado al momento de la inscripción. |
usePreferredName | boolean | Indica si el prospect utiliza un nombre preferencial. |
document | string | Documento principal del prospect (ej.: CPF). |
rg | string | Registro General (RG) del prospect. |
cellphone | string | Número de teléfono celular. |
email | string | Dirección de correo electrónico del prospect. |
gympassId | string | Identificador del prospect en plataformas asociadas (ej.: Gympass). |
registerDate | date-time | Fecha de registro del prospect. |
gender | string | Género informado por el prospect. |
birthDate | date-time | Fecha de nacimiento del prospect. |
signupType | string | Tipo de registro realizado (ej.: presencial, online, campaña). |
mktChannel | string | Canal de marketing de origen del prospect. |
conversionDate | date-time | Fecha de conversión del prospect en miembro, si aplica. |
idMember | int32 | ID del miembro asociado tras la conversión. |
currentStep | string | Etapa actual del embudo de relación/comercial. |
address | string | Dirección del prospect. |
city | string | Ciudad de la dirección. |
complement | string | Complemento de la dirección. |
neighborhood | string | Barrio de la dirección. |
state | string | Estado/provincia de la dirección. |
country | string | País de la dirección. |
zipCode | string | Código postal. |
number | string | Número de la dirección. |
temperature | string | Clasificación de interés del prospect (ej.: frío, tibio, caliente). |
notes | string | Observaciones adicionales sobre el prospect. |
interests | array | Lista de intereses registrados por el prospect. |
financiallyResponsibles | array | Responsables financieros asociados al prospect. Ver más abajo. |
🧩 Estructura de financiallyResponsibles
| Campo | Tipo | Descripción |
|---|---|---|
idMember | int32 | Identificador del miembro responsable financieramente. |
name | string | Nombre del responsable financiero. |
email | string | Correo electrónico del responsable financiero. |
cpf | string | CPF del responsable financiero. |
Solicitud
Parámetros de consulta
Respuestas
Solicitud Ejemplo de Solicitud
Shell
JavaScript
Java
Swift
curl --location 'https://evo-integracao-api.w12app.com.br/api/v1/prospects?idProspect=undefined&name=undefined&document=undefined&email=undefined&phone=undefined®isterDateStart=undefined®isterDateEnd=undefined&conversionDateStart=undefined&conversionDateEnd=undefined&take=undefined&skip=undefined&gympassId=undefined®isterName=undefined'Respuesta Ejemplo de Respuesta
200 - Ejemplo 1
[
{
"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": [
{
"idResponsible": 0,
"idMember": 0,
"name": "string",
"cpf": "string",
"email": "string",
"phone": "string",
"observation": "string",
"idMemberResponsible": 0,
"acessFiti": true,
"financialResponsible": true,
"personType": "string",
"document": "string",
"cep": "string",
"adress": "string",
"number": "string",
"complement": "string",
"district": "string",
"city": "string",
"state": "string"
}
]
}
]Modificado en 2026-05-15 13:34:34