EVO API EN
Home
GuidesAPIs💎 API Pro📢 News
Home
GuidesAPIs💎 API Pro📢 News
  1. MemberMembership
  • Welcome 💜
  • 📃 Guias
    • Primeiros passos com a API
      • Começando a usar a EVO API
      • Permissões do token
      • Limites de requisições
      • API Pro
    • Conhecendo a documentação
      • Utilizar a documentação de forma eficaz
      • Novidades
    • Casos de uso
      • Realizar venda online via API
      • Integração EVO Pay
      • Como usar o webhook
      • Agendamento de aula experimental
      • Chamadas de exportação para Excel
      • Conciliação de pagamentos via banco
      • Emissão de Nota Fiscal
      • Controle de acesso de aluno via serviço externo
      • Integrar landing page
    • FAQ
      • Gestão de clientes e relacionamentos
      • Operações e atividades
      • Financeiro
      • Configurações e integrações
    • Sugestões
      • Sugestão de implementação
  • 🌐 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
      • 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
      • 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.
      • Validates parking access authorization and information by CPF (`document`)
    • 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
    • ActivityGroupApiViewModel
    • ActivityAreaViewModel
    • ActiveMembersReturnViewModel
    • AtividadeAgendaApiViewModel
    • ActivityEmployeesViewModel
    • ActivityGroupViewModel
    • AtividadeBasicoApiViewModel
    • AtividadeAgendaApiCustomViewModel
    • ActivityResourcesViewModel
    • AtividadeListApiViewModel
    • ActivityUnavailability
    • AddressFamily
    • AtividadeLugarReservaApiViewModel
    • AreaBloqueioAgendaApiViewModel
    • AtividadeLugarReservaViewModel
    • AsnEncodedData
    • AtividadeSessaoParticipanteApiViewModel
    • AtividadeAgendaListApiViewModel
    • BairroViewModel
    • Assembly
    • AsymmetricAlgorithm
    • BandeirasBasicoViewModel
    • BankAccountsViewModel
    • BasicFreezeViewModel
    • AtividadeEnrollScheduleApiV2ViewModel
    • BasicMemberMembershipApiViewModel
    • AtividadeSessaoAgendaViewModel
    • BonusSessionViewModel
    • BusinessHoursViewModel
    • CardDataViewModel
    • CardTranslationViewModel
    • CartIdViewModel
    • CartItemsViewModel
    • CartViewModel
    • CidadeViewModel
    • BloqueioAgendaApiViewModel
    • ClienteDetalhesBasicosApiViewModel
    • ClienteEnotasRetorno
    • BranchGatewayViewModel
    • ClienteTransferenciaViewModel
    • ClientesAtivosRetornoViewModel
    • CofinsEnotasRetorno
    • ByteReadOnlyMemory
    • ConfiguracaoApiViewModel
    • ByteReadOnlySpan
    • ContratoEntradasApiViewModel
    • CallingConventions
    • ContratoFiliaisResumoApiViewModel
    • CityViewModel
    • CancellationToken
    • ChargeReceivableRequestViewModel
    • ContratosCanceladosParcelasApiViewModel
    • ChargeReceivableResponseViewModel
    • ContratosCanceladosResumoApiViewModel
    • ContratosResumoApiViewModel
    • ContratosResumoPaginaVendaViewModel
    • ColaboradoresBloqueioAgendaApiViewModel
    • ConveniosApiViewModel
    • CostCenterApiViewModel
    • ConjugadoItemRequestApiViewModel
    • Claim
    • DadosContratoTrasnferenciaApiViewModel
    • ClaimsIdentity
    • DadosTrocaContratoApiViewModel
    • ClaimsPrincipal
    • DebtorChargesViewModel
    • DebtorsItensViewModel
    • DefaultResponseViewModel
    • DiferenciaisApiViewModel
    • DifferentialsViewModel
    • EFormaContato
    • EFormaPagamentoTotem
    • EOrigemAgendamento
    • EStatusAtividade
    • ConnectionInfo
    • EStatusAtividadeSessao
    • ConstructorInfo
    • ETemperatura
    • ETipoContrato
    • ETipoDocumento
    • ETipoGateway
    • DropsetItemRequestApiViewModel
    • EmployeeApiIntegracaoAtualizacaoViewModel
    • EmployeeApiBranchPermissions
    • EmployeeApiIntegracaoViewModel
    • EmpresasConveniosApiViewModel
    • ESubStatus
    • EmpresasFiliaisGatewayViewModel
    • EmpresasFiliaisOcupacaoViewModel
    • ESubStatusApi
    • CustomAttributeData
    • EnderecoEnotasRetorno
    • CustomAttributeNamedArgument
    • EnotasRetorno
    • CustomAttributeTypedArgument
    • EntradasResumoApiViewModel
    • EstadoViewModel
    • ExperimentalClassResponseViewModel
    • FitcoinsResponseViewModel
    • FreezeViewModel
    • FreteEnotasRetorno
    • FuncionariosResumoApiViewModel
    • HttpResponseError
    • IcmsEnotasRetorno
    • ImpostosEnotasRetorno
    • InformacoesIndicadosViewModel
    • InstallmentViewModel
    • ItenEnotasRetorno
    • LiberacaoCatracaManualViewModel
    • LogTefApiViewModel
    • MemberAuthenticateViewModel
    • MemberBasicResponsibleViewModel
    • MemberBlockUnblockViewModel
    • MemberDataViewModel
    • MemberMembershipApiViewModel
    • MemberNewSaleViewModel
    • MemberResponsibleViewModel
    • IdMemberResponseViewModel
    • MemberServiceViewModel
    • MemberTransferViewModel
    • ItensBloqueioAgendaApiViewModel
    • MembersApiViewModel
    • MembersBasicApiViewModel
    • MetadadosEnotasRetorno
    • MonthDiscountViewModel
    • NewSaleViewModel
    • MatriculaDetalhesApiV2ViewModel
    • NotificationApiViewModel
    • MatricularApiViewModel
    • EventAttributes
    • NotificationProspectApiViewModel
    • MatricularConfiguracaoApiViewModel
    • EventInfo
    • NotificationResponseViewModel
    • NovoVoucherViewModel
    • FieldAttributes
    • PagamentoEnotasRetorno
    • FieldInfo
    • PayablesApiSubTypesViewModel
    • PayablesApiViewModel
    • PedidoEnotasRetorno
    • PercentualAproximadoTributosEnotasRetorno
    • MemberCreditCardApiViewModel
    • ReceivablesApiResumoVendaViewModel
    • PeriodizacaoApiViewModel
    • GenericParameterAttributes
    • PisEnotasRetorno
    • HostString
    • PixPaymentDetailsViewModel
    • HttpContext
    • PrescricaoTreinoViewModel
    • MembersApiResumidoVendaViewModel
    • MemberScheduleApiV2ViewModel
    • HttpRequest
    • ProblemDetails
    • HttpResponse
    • ProspectApiIntegracaoAtualizacaoViewModel
    • ProspectApiIntegracaoViewModel
    • ICustomAttributeProvider
    • ProspectIdViewModel
    • IIdentity
    • ProspectResponsavelFinanceiroViewmodel
    • IPAddress
    • ProspectTransferViewModel
    • NeighborhoodViewModel
    • IResponseCookies
    • ProspectTransferenciaViewModel
    • IServiceProvider
    • ProspectsResumoApiViewModel
    • ISession
    • ProtocoloEnotasRetorno
    • PublicoAtividadeViewModel
    • ReceivablesApiSubTypesViewModel
    • ReceivablesApiViewModel
    • ReceivablesApiViewModelListGridComQtdeViewModel
    • ReceivablesCreditDetails
    • IntPtr
    • ReceivablesInvoiceApiViewModel
    • VendasResumoApiViewModel
    • ProgressivoItemRequestApiViewModel
    • ReceivablesMaskReceivedViewModel
    • RetornoCatracaViewModel
    • KeySizes
    • RetornoEntradaManualViewModel
    • LayoutKind
    • RevenueCenterApiViewModel
    • SaleItensViewModel
    • SalesItemViewModel
    • SalesItemsViewModel
    • MatriculaDetalhesApiViewModel
    • SalesViewModel
    • ProdutoResumoApiViewModel
    • ServiceDiscountViewModel
    • ServicoAdicionalApiViewModel
    • ServicoAnualApiViewModel
    • ServicoEnotasRetorno
    • ServicosResumoApiViewModel
    • RecursosBloqueioAgendaApiViewModel
    • MemberInfo
    • SimplificadoEnotasRetorno
    • SpsProspectsServicosInteresses
    • MemberLevelViewModel
    • SumaryDebtorsViewModel
    • TaxDataViewModel
    • MemberParkingViewModel
    • TelefoneApiViewModel
    • TransferClientResponseViewModel
    • TransporteEnotasRetorno
    • MemberTypes
    • UnavailableSpotsResponseViewModel
    • VouchersResumoApiViewModel
    • W12UtilsCategoryMembershipViewModel
    • SerieItemRequestApiViewModel
    • W12UtilsWebhookHeaderViewModel
    • SeriePrescricaoRequestApiViewModel
    • MethodAttributes
    • W12UtilsWebhookViewModel
    • MethodBase
    • W12UtilzWebHookFilterViewModel
    • MethodImplAttributes
    • YearDiscountViewModel
    • TimeSpan
    • MethodInfo
    • autorizaEntradaExternoViewModel
    • ReverseReceivedResponseViewModel
    • retornoAutorizaEntradaExternoViewModel
    • MobilePushMultiplaViewModel
    • ReverseReceivedViewModel
    • MobilePushViewModel
    • Module
    • ModuleHandle
    • SalesViewModelV2
    • TreinoPrescricaoRequestApiViewModel
    • Oid
    • VoucherCriacaoViewModel
    • StateViewModel
    • ParameterAttributes
    • VouchersCodigosViewModel
    • ParameterInfo
    • VouchersCodigosViewModelListWithQuantityViewModel
    • PathString
    • PipeReader
    • VoucherAtributePublicViewModel
    • PipeWriter
    • VoucherItemApiViewModel
    • 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

Obter MemberMembership por id#

Descrição#

Retorna um resumo detalhado de uma associação (MemberMembership) específica, identificada por seu ID. As informações incluem dados contratuais, status, datas relevantes, sessões, congelamentos e regras associadas à suspensão ou fidelização.
OBS. Disponível para uso com chave de acesso de filial e também com chave de acesso de ADM Geral.

🔑 Parâmetro de Consulta (Path Param)#

Este endpoint exige um parâmetro obrigatório de caminho (path parameter) para identificar o MemberMembership a ser consultado.
ParâmetroTipoObrigatórioDescrição
idMemberMembershipint32SimID único do (MemberMembership) que será consultado.

📤 Estrutura da Resposta#

CampoTipoDescrição
idMemberint32ID do membro.
idMembershipint32ID do plano/membership.
idMemberMembershipint32Identificador único do vínculo do membro com o membership.
idMemberMembershipRenewedint32ID do membership renovado (se houver).
numMembersint32Quantidade de membros associados (principal + dependentes).
startDatedate-timeData de início do membership.
endDatedate-timeData de término do membership.
namestringNome do plano/membership.
cancelDatedate-timeData efetiva de cancelamento.
cancelDateOndate-timeData programada para cancelamento.
cancelCreationDatedate-timeData em que a solicitação de cancelamento foi criada.
membershipStatusstringStatus atual do membership.
valueNextMonthnumberValor da próxima mensalidade.
nextChargedate-timeData da próxima cobrança.
nextDateSuspensiondate-timePróxima data de suspensão cadastrada.
idSaleint32ID da venda associada ao membership.
saleDatedate-timeData da venda.
contractPrintingstringConteúdo ou URL para impressão do contrato.
freezesarrayLista de congelamentos do membership. Ver objeto freezes[].
idCategoryMembershipint32ID da categoria do membership.
numberSuspensionTimesint32Total de suspensões já realizadas.
maxSuspensionDaysint32Máximo de dias permitidos para suspensão.
minimumSuspensionDaysint32Mínimo de dias permitidos para suspensão.
disponibleSuspensionDaysint32Dias disponíveis para suspensão.
disponibleSuspensionTimesint32Quantidade restante de suspensões permitidas.
daysLeftToFreezeint32Dias restantes para congelamento.
loyaltyEndDatedate-timeData de fim do período de fidelidade.
assessmentEndDatedate-timeData de validade da avaliação física.
acceptanceDatedate-timeData de aceite/ativação do contrato.
flAllowLockerbooleanIndica se o membro pode utilizar locker.
flAdditionalMembershipbooleanIndica se o membership é adicional.
bioimpedanceAmountnumberQuantidade de avaliações de bioimpedância disponíveis.
signedTermsbooleanIndica se os termos foram assinados.
originalValuenumberValor original do membership no momento da venda.
allowLesMillsbooleanIndica se o plano inclui aulas Les Mills.
allowsCancellationByAppbooleanSe permite cancelamento via aplicativo.
contractSigningUrlstringURL de assinatura digital disponível para aceite de contrato.
limitlessbooleanIndica se o membership é ilimitado.
weeklyLimitint32Limite semanal de utilização/sessões.
concludedSessionsint32Total de sessões concluídas.
pendingSessionsint32Total de sessões pendentes.
scheduledSessionsint32Número de sessões agendadas.
pendingRepositionsint32Sessões pendentes de reposição.
repositionsTotalint32Quantidade total de reposições disponíveis.
bonusSessionsint32Total de sessões bônus disponíveis.
sessionsarrayLista de sessões vinculadas ao membership. Ver objeto sessions[].

🧩 Estrutura do array de objetos freezes#

CampoTipoDescrição
startSuspenddate-timeData de início da suspensão.
endSuspenddate-timeData de término da suspensão.
unlockDatedate-timeData em que o membership será reativado.
idEmployeeint32ID do colaborador que registrou o congelamento.
reasonstringMotivo informado para a suspensão.
flUseMembershipFreezeDaysbooleanSe utiliza os dias permitidos pelo membership.
daysFreezeint32Quantidade de dias congelados.
idFreezeint32ID do registro de congelamento.

🧩 Estrutura do array de objetos sessions#

CampoTipoDescrição
idSessionint32ID da sessão.
expirationDatedate-timeData de expiração da sessão.
flBonusSessionbooleanIndica se a sessão é bônus.

Request

Authorization
Basic Auth
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:password
Example:
Authorization: Basic *****************
or
Path Params

Responses

🟢200OK
application/json
Success
Body

🟠400Bad Request
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://evo-integracao-api.w12app.com.br/api/v1/membermembership/' \
--header 'Authorization: Basic <encoded-value>'
Response Response Example
200 - Example 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
}
Modified at 2026-05-15 04:38:45
Previous
Get summary of MemberMemberships (active, canceled, or specific types).
Next
Cancel MemberMembership
Built with