get https://evo-integracao-api.w12app.com.br/api/v2/membership
Recupera Contratos
Descrição
Esse endpoint permite consultar os contratos disponíveis, com opções de filtro por nome, filial, data de atualização, entre outros. Também é possível incluir informações adicionais, como grupos de atividades, observações de venda online e filiais com acesso.
Parâmetros de Consulta
Parâmetro | Tipo | Obrigatório | Descrição |
---|---|---|---|
idMembership | int | Não | Filtra pelo ID do membership específico. |
name | string | Não | Filtra pelo nome do contrato. |
idBranch | int | Não | Filtra pelo ID da filial. Ignorado se a chave de API não for multifilial. |
take | int | Não | Número total de registros a serem retornados (máximo: 50). Padrão: 25. |
skip | int | Não | Quantidade de registros a serem ignorados (para paginação). Padrão: 0. |
active | boolean | Não | Filtra por contratos ativos ou inativos. |
updateDate | string (ISO) | Não | Filtra contratos atualizados a partir desta data (yyyy-mm-dd ). |
showAccessBranches | boolean | Não | Exibe as filiais em que o contrato garante acesso. Padrão: false . |
showOnlineSalesObservation | boolean | Não | Exibe observações referentes à venda online. Padrão: false . |
showActivitiesGroups | boolean | Não | Exibe os grupos de atividades vinculados ao contrato. Padrão: false . |
Exemplo de Resposta
[
{
"idMembership": 123,
"idBranch": 10,
"nameMembership": "Plano Anual Premium",
"membershipType": "Mensalidade",
"durationType": "Mensal",
"duration": 12,
"updateDate": "2025-07-21T16:20:07.812Z",
"value": 129.90,
"maxAmountInstallments": 12,
"description": "Plano anual com acesso a todas as unidades.",
"urlSale": "https://academia.com/planos/123",
"onlineSalesObservations": "Pagamento recorrente com desconto.",
"differentials": [
{
"title": "Acesso a todas as unidades",
"order": 1
}
],
"accessBranches": [
{
"idBranch": 10,
"name": "Unidade Centro"
},
{
"idBranch": 12,
"name": "Unidade Zona Sul"
}
],
"additionalService": {
"idService": 45,
"name": "Avaliação Física",
"value": 49.90
},
"serviceYearly": {
"idService": 88,
"name": "Manutenção Anual",
"value": 99.90,
"type": 1,
"billingMonth": 1,
"billingDay": 10,
"billingAfterMonths": 6,
"installments": 2
},
"typePromotionalPeriod": 1,
"valuePromotionalPeriod": 99.90,
"monthsPromotionalPeriod": 3,
"daysPromotionalPeriod": 0,
"minPeriodStayMembership": 6,
"installmentsPromotionalPeriod": 3,
"activitiesGroups": [
{
"idGroupActivity": 1,
"name": "Musculação e Cardio",
"idBranch": 10
}
],
"inactive": false,
"displayName": "Anual Premium",
"entries": {
"entriesQuantity": 999,
"idEntriesType": 1,
"entriesTypeDescription": "Acesso ilimitado"
},
"salesPage": [
{
"idSalesPage": 1,
"order": 1,
"salesPageDescription": "Página inicial"
}
],
"allowsCancellationByApp": true
}
]