EVO API ES
Inicio
GuíasAPIs💎 API Pro📢 Novedades
Inicio
GuíasAPIs💎 API Pro📢 Novedades
  1. MemberMembership
  • ¡Bienvenido 💜
  • 📃 Guías
    • Primeros pasos con la API
      • Primeros pasos con la EVO API
      • Permisos de token
      • Límites de solicitudes
      • API Pro
    • Comprender la documentación
      • Utilizar la documentación de forma eficaz
      • Novedades
    • Casos de uso
      • Realizar ventas online a través de API
      • Integración de EVO Pay
      • Cómo usar webhooks
      • Agendamiento de una clase experimental
      • Exportar llamadas a Excel
      • Conciliación de pagos bancarios
      • Emisión de factura
    • FAQ
      • Configuraciones e integraciones
      • Gestión de clientes y relaciones
      • Operación y actividades
      • Financiero
    • Sugerencias
      • Sugerencia de implementación
  • 🌐 API Reference
    • AccessControl
      • Post access control entry authorize
      • Post access control insert manual liberation
      • Get access control turnstiles
      • Update access control serial number turnstiles
    • Activities
      • Get activities
      • Get activities schedule
      • Get activities schedule details
      • Enroll member in activity schedule
      • Change status of a member in activity schedule
      • Create a new experimental class and enroll the member on it
      • List of spots that are already filled in the activity session
      • Get activities schedule by idService or idMembership
      • Get activities enrollment by member or membership
      • Create a new enrollment for a member
      • Delete enrollment
      • Get enrollment details for a member
      • Book member in activity schedule
      • Change status of a member in activity schedule
      • Get activities schedule by enrollment
      • Create a new enrollment for a member
      • Delete enrollment
      • Get enrollment details for a member
      • Get activity sessions for a member
    • Appointments
      • Get activities
      • Retrieves detailed information about scheduled appointment sessions
      • Get blocked appointments
      • Get available activities for appointment
      • Get the available times for appointment
      • Change status of a member in a appointment
      • Enroll member in activity appointment
    • BankAccounts
      • Get bank accounts
    • Carts
      • Get cart by idCartToken
      • Get cart by idMember or idProspect
      • Add new cart
      • Forfeit cart
    • Configuration
      • Get branch configurations
      • Get gateway configurations
      • Get gateway form token
      • Get card flag
      • Get card translation
      • Get occupation
    • Employees
      • Get employees
      • Add employees
      • Update employees
      • Delete employees
      • Retrieves employee permissions.
    • Entries
      • Get entries
    • Invoices
      • Get invoices by date
    • Management
      • Get non-renewed clients
      • Get prospects
      • Get active clients
    • MemberMembership
      • Get summary of MemberMemberships (active, canceled, or specific types).
        GET
      • Get summary of MemberMemberships by id
        GET
      • Cancel MemberMembership
        POST
      • Revert scheduled membership cancellation.
        POST
    • Members
      • Get member profile
      • Get members
      • Retrieves active members from a specific branch or from all branches
      • Get member services
      • Get member credit cards
      • Update a member card number
      • Authenticate member
      • Get link for reset password
      • Update a member fitcoins
      • Get member fitcoins
      • Get basic member information.
      • Get member's latest branch transfer
      • Update basic member data
      • Transfers a member from one branch to another
      • Block/unblock member
      • Send push notification to a specific member
      • Send push notification to multiple members
    • Membership
      • Get memberships
      • Get memberships categories
    • Notifications
      • Insert a member notification
      • Insert a prospect notification
    • Parking
      • Validates parking access authorization by CPF (`document`) or by `idMember` for a specific branch.
    • Partnership
      • Get partnerships
    • Payables
      • Get payables
      • Get cost center
    • Pix
      • Get qr-code
    • Product
      • Get products
    • Prospects
      • Get prospects
      • Add prospects
      • Update prospect
      • Get prospect services
      • Transfers a prospect from one branch to another
      • Get prospect's latest branch transfer
      • Get interests list
      • Turn the opportunity into a member, returns the idMember created.
    • Receivables
      • Gets a list of debts and current status (Similar to the Collections - Default report)
      • Creates batch collection attempts for the member membership contracts.
      • Gets the details of a specific charge batch.
      • Get receivables
      • Marks a list of receivables as received (paid)
      • Reverses a list of received (paid) receivables back to open status
      • Get cost center
      • Get receivables conciliation report
      • Charge a receivable using a member's credit card
    • Sales
      • Get sale by Id
      • Get sales
      • Create a new sale
      • Get sales bySessionId
      • Return itens for sale -> site/totem
    • Service
      • Get services
    • States
      • Get all states for the current user's country
    • Voucher
      • Get vouchers
      • Get all vouchers code by voucher id
      • Creates a new voucher
      • Validate the voucher
    • Webhook
      • Add new webhook
      • Remove a specific webhook by id
      • List all webhooks created
      • List all webhooks created
    • Workout
      • Change data from a client's prescribed workout
      • Get all Exercises
      • Get all default workouts of the new prescription
      • Get all client's or prospect's or employee's workouts of the new prescription
      • Get all client's or prospect's or employee's workouts of the new prescription by month, year or idProfessor
      • Link workout of the new prescription for client
      • Create a workout of the new prescription
  • Schemas
    • Schemas
      • ClientesAtivosViewModel
      • ContratoNaoRenovadosViewModel
      • SpsRelProspectsCadastradosConvertidos
    • ActiveMembersReturnViewModel
    • ActivityAreaViewModel
    • ActivityEmployeesViewModel
    • ActivityGroupApiViewModel
    • ActivityGroupViewModel
    • ActivityResourcesViewModel
    • ActivityUnavailability
    • AreaBloqueioAgendaApiViewModel
    • AtividadeAgendaApiCustomViewModel
    • AtividadeAgendaApiViewModel
    • AtividadeAgendaListApiViewModel
    • AtividadeBasicoApiViewModel
    • AtividadeEnrollScheduleApiV2ViewModel
    • AtividadeListApiViewModel
    • AddressFamily
    • AtividadeLugarReservaApiViewModel
    • AtividadeLugarReservaViewModel
    • AtividadeSessaoAgendaViewModel
    • AtividadeSessaoParticipanteApiViewModel
    • AsnEncodedData
    • BairroViewModel
    • BandeirasBasicoViewModel
    • Assembly
    • BankAccountsViewModel
    • BasicFreezeViewModel
    • AsymmetricAlgorithm
    • BasicMemberMembershipApiViewModel
    • BloqueioAgendaApiViewModel
    • BonusSessionViewModel
    • BranchGatewayViewModel
    • BusinessHoursViewModel
    • CardDataViewModel
    • CardTranslationViewModel
    • CartIdViewModel
    • CartItemsViewModel
    • CartViewModel
    • ChargeReceivableRequestViewModel
    • ChargeReceivableResponseViewModel
    • CidadeViewModel
    • CityViewModel
    • ClienteDetalhesBasicosApiViewModel
    • ClienteEnotasRetorno
    • ClienteTransferenciaViewModel
    • CofinsEnotasRetorno
    • ColaboradoresBloqueioAgendaApiViewModel
    • ClientesAtivosRetornoViewModel
    • ConfiguracaoApiViewModel
    • ConjugadoItemRequestApiViewModel
    • ContratoEntradasApiViewModel
    • ByteReadOnlyMemory
    • ContratoFiliaisResumoApiViewModel
    • ContratosCanceladosParcelasApiViewModel
    • ByteReadOnlySpan
    • ContratosCanceladosResumoApiViewModel
    • ContratosResumoApiViewModel
    • CallingConventions
    • ContratosResumoPaginaVendaViewModel
    • ConveniosApiViewModel
    • CancellationToken
    • CostCenterApiViewModel
    • DadosContratoTrasnferenciaApiViewModel
    • DadosTrocaContratoApiViewModel
    • DebtorChargesViewModel
    • DebtorsItensViewModel
    • DefaultResponseViewModel
    • DiferenciaisApiViewModel
    • DifferentialsViewModel
    • DropsetItemRequestApiViewModel
    • EFormaContato
    • Claim
    • EFormaPagamentoTotem
    • EOrigemAgendamento
    • ClaimsIdentity
    • EStatusAtividade
    • EStatusAtividadeSessao
    • ClaimsPrincipal
    • ESubStatus
    • ESubStatusApi
    • ETemperatura
    • ETipoContrato
    • ETipoDocumento
    • ETipoGateway
    • EmployeeApiBranchPermissions
    • EmployeeApiIntegracaoAtualizacaoViewModel
    • EmployeeApiIntegracaoViewModel
    • EmpresasConveniosApiViewModel
    • ConnectionInfo
    • EmpresasFiliaisOcupacaoViewModel
    • EnderecoEnotasRetorno
    • ConstructorInfo
    • EnotasRetorno
    • EntradasResumoApiViewModel
    • ExperimentalClassResponseViewModel
    • FitcoinsResponseViewModel
    • FreezeViewModel
    • FreteEnotasRetorno
    • FuncionariosResumoApiViewModel
    • HttpResponseError
    • IcmsEnotasRetorno
    • IdMemberResponseViewModel
    • EmpresasFiliaisGatewayViewModel
    • ImpostosEnotasRetorno
    • InformacoesIndicadosViewModel
    • InstallmentViewModel
    • ItenEnotasRetorno
    • CustomAttributeData
    • ItensBloqueioAgendaApiViewModel
    • LiberacaoCatracaManualViewModel
    • CustomAttributeNamedArgument
    • LogTefApiViewModel
    • MatriculaDetalhesApiV2ViewModel
    • CustomAttributeTypedArgument
    • MatriculaDetalhesApiViewModel
    • EstadoViewModel
    • MatricularApiViewModel
    • MatricularConfiguracaoApiViewModel
    • MemberAuthenticateViewModel
    • MemberBasicResponsibleViewModel
    • MemberBlockUnblockViewModel
    • MemberCreditCardApiViewModel
    • MemberDataViewModel
    • MemberLevelViewModel
    • MemberMembershipApiViewModel
    • MemberNewSaleViewModel
    • MemberParkingViewModel
    • MemberResponsibleViewModel
    • MemberScheduleApiV2ViewModel
    • MemberServiceViewModel
    • MemberTransferViewModel
    • MembersApiResumidoVendaViewModel
    • MembersApiViewModel
    • MembersBasicApiViewModel
    • MetadadosEnotasRetorno
    • MobilePushMultiplaViewModel
    • MobilePushViewModel
    • MonthDiscountViewModel
    • NeighborhoodViewModel
    • NewSaleViewModel
    • NotificationApiViewModel
    • NotificationProspectApiViewModel
    • NotificationResponseViewModel
    • NovoVoucherViewModel
    • PagamentoEnotasRetorno
    • PayablesApiSubTypesViewModel
    • PayablesApiViewModel
    • PedidoEnotasRetorno
    • PercentualAproximadoTributosEnotasRetorno
    • PeriodizacaoApiViewModel
    • EventAttributes
    • PisEnotasRetorno
    • PixPaymentDetailsViewModel
    • EventInfo
    • PrescricaoTreinoViewModel
    • ProblemDetails
    • ProdutoResumoApiViewModel
    • FieldAttributes
    • ProgressivoItemRequestApiViewModel
    • ProspectApiIntegracaoAtualizacaoViewModel
    • FieldInfo
    • ProspectApiIntegracaoViewModel
    • ProspectIdViewModel
    • ProspectResponsavelFinanceiroViewmodel
    • ProspectTransferViewModel
    • ProspectTransferenciaViewModel
    • ProspectsResumoApiViewModel
    • GenericParameterAttributes
    • ProtocoloEnotasRetorno
    • PublicoAtividadeViewModel
    • HostString
    • ReceivablesApiResumoVendaViewModel
    • ReceivablesApiSubTypesViewModel
    • HttpContext
    • ReceivablesApiViewModel
    • ReceivablesApiViewModelListGridComQtdeViewModel
    • HttpRequest
    • ReceivablesCreditDetails
    • ReceivablesInvoiceApiViewModel
    • HttpResponse
    • ReceivablesMaskReceivedViewModel
    • RecursosBloqueioAgendaApiViewModel
    • RetornoCatracaViewModel
    • ICustomAttributeProvider
    • RetornoEntradaManualViewModel
    • RevenueCenterApiViewModel
    • IIdentity
    • ReverseReceivedResponseViewModel
    • ReverseReceivedViewModel
    • IPAddress
    • SaleItensViewModel
    • SalesItemViewModel
    • SalesItemsViewModel
    • IResponseCookies
    • SalesViewModelV2
    • SerieItemRequestApiViewModel
    • IServiceProvider
    • SeriePrescricaoRequestApiViewModel
    • ServiceDiscountViewModel
    • ISession
    • ServicoAdicionalApiViewModel
    • ServicoAnualApiViewModel
    • ServicoEnotasRetorno
    • ServicosResumoApiViewModel
    • SimplificadoEnotasRetorno
    • SpsProspectsServicosInteresses
    • StateViewModel
    • SumaryDebtorsViewModel
    • IntPtr
    • TaxDataViewModel
    • TelefoneApiViewModel
    • TransferClientResponseViewModel
    • TransporteEnotasRetorno
    • KeySizes
    • TreinoPrescricaoRequestApiViewModel
    • UnavailableSpotsResponseViewModel
    • LayoutKind
    • VendasResumoApiViewModel
    • VoucherAtributePublicViewModel
    • VoucherCriacaoViewModel
    • VoucherItemApiViewModel
    • VouchersCodigosViewModel
    • SalesViewModel
    • VouchersCodigosViewModelListWithQuantityViewModel
    • VouchersResumoApiViewModel
    • W12UtilsCategoryMembershipViewModel
    • W12UtilsWebhookHeaderViewModel
    • W12UtilsWebhookViewModel
    • W12UtilzWebHookFilterViewModel
    • YearDiscountViewModel
    • autorizaEntradaExternoViewModel
    • retornoAutorizaEntradaExternoViewModel
    • MemberInfo
    • MemberTypes
    • MethodAttributes
    • MethodBase
    • TimeSpan
    • MethodImplAttributes
    • MethodInfo
    • Module
    • ModuleHandle
    • Oid
    • ParameterAttributes
    • ParameterInfo
    • PathString
    • PipeReader
    • PipeWriter
    • PropertyAttributes
    • PropertyInfo
    • PublicKey
    • QueryString
    • RuntimeFieldHandle
    • RuntimeMethodHandle
    • RuntimeTypeHandle
    • SafeWaitHandle
    • SecurityRuleSet
    • Stream
    • StringStringKeyValuePair
    • StringStringValuesKeyValuePair
    • StructLayoutAttribute
    • Type
    • TypeAttributes
    • TypeInfo
    • TypeObjectKeyValuePair
    • WaitHandle
    • WebSocketManager
    • X500DistinguishedName
    • X509Certificate2
    • X509Extension
  1. MemberMembership

Get summary of MemberMemberships by id

GET
https://evo-integracao-api.w12app.com.br/api/v1/membermembership/{idMemberMembership}
🌐 API Reference/MemberMembership

Obtener MemberMembership por ID#

Descripción#

Devuelve un resumen detallado de una asociación (MemberMembership) específica, identificada por su ID. La información incluye datos contractuales, estado, fechas relevantes, sesiones, congelamientos y reglas asociadas a suspensión o fidelización.
OBS. Disponible para uso con clave de acceso de filial y también con clave de acceso de ADM General.

🔑 Parámetro de Consulta (Path Param)#

ParámetroTipoObligatorioDescripción
idMemberMembershipint32SíID único del (MemberMembership) que se consultará.

📤 Estructura de la Respuesta#

CampoTipoDescripción
idMemberint32ID del miembro.
idMembershipint32ID del plan/membership.
idMemberMembershipint32Identificador único del vínculo del miembro con el membership.
idMemberMembershipRenewedint32ID del membership renovado (si aplica).
numMembersint32Cantidad de miembros asociados (principal + dependientes).
startDatedate-timeFecha de inicio del membership.
endDatedate-timeFecha de finalización del membership.
namestringNombre del plan/membership.
cancelDatedate-timeFecha efectiva de cancelación.
cancelDateOndate-timeFecha programada para cancelación.
cancelCreationDatedate-timeFecha en que se creó la solicitud de cancelación.
membershipStatusstringEstado actual del membership.
valueNextMonthnumberValor de la próxima mensualidad.
nextChargedate-timeFecha del próximo cobro.
nextDateSuspensiondate-timePróxima fecha de suspensión registrada.
idSaleint32ID de la venta asociada al membership.
saleDatedate-timeFecha de la venta.
contractPrintingstringContenido o URL para impresión del contrato.
freezesarrayLista de congelamientos del membership. Ver objeto freezes[].
idCategoryMembershipint32ID de la categoría del membership.
numberSuspensionTimesint32Total de suspensiones realizadas.
maxSuspensionDaysint32Máximo de días permitidos para suspensión.
minimumSuspensionDaysint32Mínimo de días permitidos para suspensión.
disponibleSuspensionDaysint32Días disponibles para suspensión.
disponibleSuspensionTimesint32Cantidad restante de suspensiones permitidas.
daysLeftToFreezeint32Días restantes para congelamiento.
loyaltyEndDatedate-timeFecha de fin del período de fidelización.
assessmentEndDatedate-timeFecha de finalización de la evaluación física.
acceptanceDatedate-timeFecha de aceptación/activación del contrato.
flAllowLockerbooleanIndica si el miembro puede utilizar locker.
flAdditionalMembershipbooleanIndica si el membership es adicional.
bioimpedanceAmountnumberCantidad de evaluaciones de bioimpedancia disponibles.
signedTermsbooleanIndica si los términos fueron firmados.
originalValuenumberValor original del membership al momento de la venta.
allowLesMillsbooleanIndica si el plan incluye clases Les Mills.
allowsCancellationByAppbooleanIndica si se permite cancelación vía app.
contractSigningUrlstringURL de firma digital disponible para aceptación de contrato.
limitlessbooleanIndica si el membership es ilimitado.
weeklyLimitint32Límite semanal de uso/sesiones.
concludedSessionsint32Total de sesiones concluidas.
pendingSessionsint32Total de sesiones pendientes.
scheduledSessionsint32Total de sesiones agendadas.
pendingRepositionsint32Sesiones pendientes de reposición.
repositionsTotalint32Total de reposiciones disponibles.
bonusSessionsint32Total de sesiones bono disponibles.
sessionsarrayLista de sesiones vinculadas al membership. Ver objeto sessions[].

🧩 Estructura del array de objetos freezes#

CampoTipoDescripción
startSuspenddate-timeFecha de inicio de la suspensión.
endSuspenddate-timeFecha de finalización de la suspensión.
unlockDatedate-timeFecha en que el membership será reactivado.
idEmployeeint32ID del colaborador que registró el congelamiento.
reasonstringMotivo informado para la suspensión.
flUseMembershipFreezeDaysbooleanIndica si se usan los días permitidos por el membership.
daysFreezeint32Cantidad de días congelados.
idFreezeint32ID del registro de congelamiento.

🧩 Estructura del array de objetos sessions#

CampoTipoDescripción
idSessionint32ID de la sesión.
expirationDatedate-timeFecha de expiración de la sesión.
flBonusSessionbooleanIndica si la sesión es bono.

Solicitud

Autorización
or
Parámetros de ruta

Respuestas

🟢200OK
application/json
Success
Body

🟠400Bad Request
Solicitud Ejemplo de Solicitud
Shell
JavaScript
Java
Swift
curl --location 'https://evo-integracao-api.w12app.com.br/api/v1/membermembership/'
Respuesta Ejemplo de Respuesta
200 - Ejemplo 1
{
    "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
}
Modificado en 2026-05-15 13:34:34
Anterior
Get summary of MemberMemberships (active, canceled, or specific types).
Siguiente
Cancel MemberMembership
Built with