Get members
GET
https://evo-integracao-api.w12app.com.br/api/v2/members
🌐 API Reference/Members
Obtener Miembros
Descripción
🚧 OBS. Para que el campo statusse devuelva correctamente, es necesario establecershowMemberships=true.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 |
|---|---|---|---|
| name | string | No | Filtra los miembros por nombre. |
| string | No | Filtra los miembros por correo electrónico. | |
| document | string | No | Filtra los miembros por número de documento. |
| phone | string | No | Filtra los miembros por teléfono o celular. Ej.: 1112341234 |
| conversionDateStart | date-time | No | Filtra los miembros por fecha de conversión inicial. (Formato: yyyy-mm-dd) |
| conversionDateEnd | date-time | No | Filtra los miembros por fecha de conversión final. (Formato: yyyy-mm-dd) |
| registerDateStart | date-time | No | Filtra los miembros por fecha de registro inicial. (Formato: yyyy-mm-dd) |
| registerDateEnd | date-time | No | Filtra los miembros por fecha de registro final. (Formato: yyyy-mm-dd) |
| membershipStartDateStart | date-time | No | Filtra los miembros por fecha de inicio de la matrícula. (Formato: yyyy-mm-dd) |
| membershipStartDateEnd | date-time | No | Filtra los miembros por fecha de inicio de la matrícula. (Formato: yyyy-mm-dd) |
| membershipCancelDateStart | date-time | No | Filtra los miembros por fecha de cancelación de la matrícula. (Formato: yyyy-mm-dd) |
| membershipCancelDateEnd | date-time | No | Filtra los miembros por fecha de cancelación de la matrícula. (Formato: yyyy-mm-dd) |
| status | int32 | No | Filtra los miembros por estado: 1 - Activo (incluye Suspendidos y VIPs), 2 - Inactivo |
| tokenGympass | string | No | Filtra por token del miembro en Gympass. |
| take | int32 | No | Define el número total de registros a devolver. Valor predeterminado 50. Máximo 50. |
| skip | int32 | No | Define el número de registros a omitir. Valor predeterminado 0. |
| idsMembers | string | No | Filtra por IDs de miembros. Agregar IDs separados por comas (Ej.: 1,2,3) |
| onlyPersonal | boolean | No | Define si se muestran únicamente entrenadores personales. Valor predeterminado false. |
| personalType | int32 | No | Filtra por tipo de personal trainer: 1 - Interno, 2 - Externo |
| showActivityData | boolean | No | Define si se muestran datos de actividad de los miembros. Valor predeterminado false. |
| idBranch | int32 | No | Filtra por ID de sucursal del miembro. (Disponible solo con clave multilocation) |
| updateDate | date-time | No | Filtra miembros con datos actualizados mayores o iguales a la fecha proporcionada. (Formato: yyyy-mm-dd) |
| showMemberships | boolean | No | Define si se muestran los datos de matrícula de los miembros. Valor predeterminado false. |
| showsResponsibles | boolean | No | Define si se muestran los datos de los responsables del miembro. Valor predeterminado false. |
| membershipEndDateStart | string | No | Filtra los miembros por fecha inicial del fin de la matrícula. (Formato: yyyy-mm-dd) |
| membershipEndDateEnd | string | No | Filtra los miembros por fecha final del fin de la matrícula. (Formato: yyyy-mm-dd) |
| registerName | string | No | Filtra los miembros por nombre de registro. |
🔷 Enum de status
| Código | Descripción |
|---|---|
| 1 | Miembro Activo (incluye Suspendidos y VIPs) |
| 2 | Miembro Inactivo |
🔷 Enum de personalType
| Descripción | Código |
|---|---|
| Interno | 1 |
| Externo | 2 |
Solicitud
Parámetros de consulta
Respuestas
Solicitud Ejemplo de Solicitud
Shell
JavaScript
Java
Swift
curl --location 'https://evo-integracao-api.w12app.com.br/api/v2/members?name=undefined&email=undefined&document=undefined&phone=undefined&conversionDateStart=undefined&conversionDateEnd=undefined®isterDateStart=undefined®isterDateEnd=undefined&membershipStartDateStart=undefined&membershipStartDateEnd=undefined&membershipCancelDateStart=undefined&membershipCancelDateEnd=undefined&status=undefined&tokenGympass=undefined&codeTotalpass=undefined&take=undefined&skip=undefined&idsMembers=undefined&onlyPersonal=undefined&personalType=undefined&showActivityData=undefined&idBranch=undefined&updateDate=undefined&showMemberships=undefined&showsResponsibles=undefined&membershipEndDateStart=undefined&membershipEndDateEnd=undefined®isterName=undefined'Respuesta Ejemplo de Respuesta
200 - Ejemplo 1
{
"idMember": 0,
"firstName": "string",
"lastName": "string",
"registerName": "string",
"registerLastName": "string",
"usePreferredName": true,
"registerDate": "2019-08-24T14:15:22.123Z",
"idBranch": 0,
"branchName": "string",
"accessBlocked": true,
"blockedReason": "string",
"document": "string",
"documentId": "string",
"maritalStatus": "string",
"gender": "string",
"birthDate": "2019-08-24T14:15:22.123Z",
"updateDate": "2019-08-24T14:15:22.123Z",
"address": "string",
"state": "string",
"city": "string",
"zipCode": "string",
"complement": "string",
"neighborhood": "string",
"accessCardNumber": "string",
"number": "string",
"totalFitCoins": 0,
"membershipStatus": "string",
"penalized": true,
"status": "string",
"contacts": [
{
"idPhone": 0,
"idMember": 0,
"idEmployee": 0,
"idProspect": 0,
"idProvider": 0,
"idContactType": 1,
"contactType": "string",
"ddi": "string",
"description": "string"
}
],
"memberships": [
{
"contractSigningUrl": "string",
"limitless": true,
"weeklyLimit": 0,
"concludedSessions": 0,
"pendingSessions": 0,
"scheduledSessions": 0,
"pendingRepositions": 0,
"repositionsTotal": 0,
"bonusSessions": 0,
"sessions": [
{
"idSession": 0,
"expirationDate": "2019-08-24T14:15:22.123Z",
"flBonusSession": true
}
],
"idMember": 0,
"idMembership": 0,
"idMemberMembership": 0,
"idMemberMembershipRenewed": 0,
"numMembers": 0,
"startDate": "2019-08-24T14:15:22.123Z",
"endDate": "2019-08-24T14:15:22.123Z",
"name": "string",
"cancelDate": "2019-08-24T14:15:22.123Z",
"cancelDateOn": "2019-08-24T14:15:22.123Z",
"cancelCreationDate": "2019-08-24T14:15:22.123Z",
"membershipStatus": "string",
"valueNextMonth": 0,
"nextCharge": "2019-08-24T14:15:22.123Z",
"nextDateSuspension": "2019-08-24T14:15:22.123Z",
"idSale": 0,
"saleDate": "2019-08-24T14:15:22.123Z",
"contractPrinting": "string",
"freezes": [
{
"startSuspend": "2019-08-24T14:15:22.123Z",
"endSuspend": "2019-08-24T14:15:22.123Z",
"unlockDate": "2019-08-24T14:15:22.123Z",
"idEmployee": 0,
"reason": "string",
"flUseMembershipFreezeDays": true,
"daysFreeze": 0,
"idFreeze": 0
}
],
"idCategoryMembership": 0,
"numberSuspensionTimes": 0,
"maxSuspensionDays": 0,
"minimumSuspensionDays": 0,
"disponibleSuspensionDays": 0,
"disponibleSuspensionTimes": 0,
"daysLeftToFreeze": 0,
"loyaltyEndDate": "2019-08-24T14:15:22.123Z",
"assessmentEndDate": "2019-08-24T14:15:22.123Z",
"acceptanceDate": "2019-08-24T14:15:22.123Z",
"flAllowLocker": true,
"flAdditionalMembership": true,
"bioimpedanceAmount": 0,
"signedTerms": true,
"originalValue": 0,
"allowLesMills": true,
"allowsCancellationByApp": true
}
],
"lastAccessDate": "2019-08-24T14:15:22.123Z",
"conversionDate": "2019-08-24T14:15:22.123Z",
"idEmployeeConsultant": 0,
"nameEmployeeConsultant": "string",
"idEmployeeInstructor": 0,
"nameEmployeeInstructor": "string",
"idEmployeePersonalTrainer": 0,
"nameEmployeePersonalTrainer": "string",
"photoUrl": "string",
"country": "string",
"idMemberMigration": "string",
"responsibles": [
{
"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"
}
],
"gympassId": "string",
"personalTrainer": true,
"personalType": "string",
"cref": "string",
"crefExpirationDate": "2019-08-24T14:15:22.123Z",
"codeTotalpass": "string",
"userIdGurupass": "string",
"clientWithPromotionalRestriction": true
}Modificado en 2026-05-15 13:34:34