Get memberships
GET
https://evo-integracao-api.w12app.com.br/api/v2/membership
🌐 API Reference/Membership
Recupera Contratos
Descrição
OBS. Disponível para uso com chave de acesso de filial e também com chave de acesso de ADM Geral.
🔑 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 plano/contrato. Padrão: false. |
📤 Estrutura da Resposta
| Campo | Tipo | Descrição |
|---|---|---|
idMembership | int32 | Identificador único do plano. |
idBranch | int32 | ID da filial associada ao plano. |
nameMembership | string | Nome do plano. |
membershipType | string | Tipo do plano. |
durationType | string | Tipo de duração do plano (ex.: mensal, anual). |
duration | int32 | Duração do plano conforme o tipo definido. |
updateDate | date-time | Data da última atualização do plano. |
value | number (double) | Valor do plano. |
maxAmountInstallments | int32 | Quantidade máxima de parcelas permitidas. |
description | string | Descrição detalhada do plano. |
urlSale | string (read-only) | URL pública para venda do plano. |
onlineSalesObservations | string | Observações exibidas no fluxo de vendas online. |
diferentials | arrayobject | Lista de diferenciais associados ao plano. Ver mais abaixo. |
accessBranches | arrayobject | Lista de unidades onde o plano é válido. Ver mais abaixo. |
additionalService | arrayobject | Serviço adicional vinculado ao plano. Ver mais abaixo. |
serviceYearly | arrayobject | Serviço anual associado ao plano. Ver mais abaixo. |
typePromotionalPeriod | int32 | Tipo de período promocional aplicado ao plano ou serviço, definindo a regra de duração da promoção. |
valuePromotionalPeriod | number | Valor aplicado durante o período promocional. |
monthsPromotionalPeriod | int32 | Quantidade de meses de duração do período promocional, quando aplicável. |
daysPromotionalPeriod | int32 | Quantidade de dias de duração do período promocional, quando aplicável. |
minPeriodStayMembership | int32 | Período mínimo de permanência no plano. |
installmentsPromotionalPeriod | int32 | Quantidade de parcelas permitidas durante o período promocional. |
activitiesGroups | arrayobject | Grupos de atividades vinculados ao plano. Ver mais abaixo. |
inactive | boolean | Indica se o plano está inativo. |
displayName | string | Nome de exibição formatado do plano. |
entries | arrayobject | Configuração de entradas permitidas pelo plano. Ver mais abaixo. |
salesPage | arrayobject | Páginas de venda associadas ao plano. Ver mais abaixo. |
allowsCancellationByApp | boolean | Indica se o plano pode ser cancelado pelo aplicativo. |
externalSaleAvailable | boolean | Indica se o plano pode ser vendido externamente. |
acceptEnrollment | boolean | Indica se aceita inscrição direta. |
enrollmentRequired | boolean | Indica se exige inscrição obrigatória. |
🧩 Estrutura de diferentials
| Campo | Tipo | Descrição |
|---|---|---|
title | string | |
order | int32 |
🧩 Estrutura de accessBranches
| Campo | Tipo | Descrição |
|---|---|---|
idBranch | int32 | Identificador da unidade à qual o membro possui acesso. |
name | string | Nome da unidade à qual o membro possui acesso. |
🧩 Estrutura de additionalService
| Campo | Tipo | Descrição |
|---|---|---|
idService | int32 | Identificador do serviço adicional. |
name | string | Nome do serviço adicional. |
value | number | Valor do serviço adicional. |
🧩 Estrutura de serviceYearly
| Campo | Tipo | Descrição |
|---|---|---|
idService | int32 | ID do serviço anual. |
name | string | Nome do serviço anual. |
value | number (double) | Valor do serviço anual. |
type | int32 | Tipo de cobrança do serviço. |
billingMonth | int32 | Mês de cobrança. |
billingDay | int32 | Dia de cobrança. |
billingAfterMonths | int32 | Meses após a contratação para cobrança. |
installments | int32 | Quantidade de parcelas. |
typePromotionalPeriod | int32 | Tipo de período promocional. |
valuePromotionalPeriod | number (double) | Valor promocional. |
monthsPromotionalPeriod | int32 | Quantidade de meses promocionais. |
daysPromotionalPeriod | int32 | Quantidade de dias promocionais. |
installmentsPromotionalPeriod | int32 | Parcelas no período promocional. |
🧩 Estrutura de activitiesGroups
| Campo | Tipo | Descrição |
|---|---|---|
idGroupActivity | int32 | ID do grupo de atividade. |
name | string | Nome do grupo de atividade. |
idBranch | int32 | ID da filial associada ao grupo. |
🧩 Estrutura de entries
| Campo | Tipo | Descrição |
|---|---|---|
entriesQuantity | int32 | Quantidade de entradas permitidas. |
idEntriesType | int32 | Tipo de entrada configurada. |
entriesTypeDescription | string | Descrição do tipo de entrada. |
🧩 Estrutura de salesPage
| Campo | Tipo | Descrição |
|---|---|---|
idSalesPage | int32 | ID da página de vendas. |
order | int32 | Ordem de exibição do plano na página. |
salesPageDescription | string | Descrição da página de vendas. |
Request
Query Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://evo-integracao-api.w12app.com.br/api/v2/membership?idMembership=undefined&name=undefined&idBranch=undefined&take=undefined&skip=undefined&active=undefined&showAccessBranches=undefined&showOnlineSalesObservation=undefined&updateDate=undefined&showActivitiesGroups=undefined&externalSaleAvailable=undefined' \
--header 'Authorization: Basic <encoded-value>'Response Response Example
200 - Example 1
[
{
"idMembership": 0,
"idBranch": 0,
"nameMembership": "string",
"membershipType": "string",
"durationType": "string",
"duration": 0,
"updateDate": "2019-08-24T14:15:22.123Z",
"value": 0,
"maxAmountInstallments": 0,
"description": "string",
"urlSale": "string",
"onlineSalesObservations": "string",
"differentials": [
{
"title": "string",
"order": 0
}
],
"accessBranches": [
{
"idBranch": 0,
"name": "string"
}
],
"additionalService": {
"idService": 0,
"name": "string",
"value": 0
},
"serviceYearly": {
"idService": 0,
"name": "string",
"value": 0,
"type": 0,
"billingMonth": 0,
"billingDay": 0,
"billingAfterMonths": 0,
"installments": 0
},
"typePromotionalPeriod": 0,
"valuePromotionalPeriod": 0,
"monthsPromotionalPeriod": 0,
"daysPromotionalPeriod": 0,
"minPeriodStayMembership": 0,
"installmentsPromotionalPeriod": 0,
"activitiesGroups": [
{
"idGroupActivity": 0,
"name": "string",
"idBranch": 0
}
],
"inactive": true,
"displayName": "string",
"entries": {
"entriesQuantity": 0,
"idEntriesType": 0,
"entriesTypeDescription": "string"
},
"salesPage": [
{
"idSalesPage": 0,
"order": 0,
"salesPageDescription": "string"
}
],
"allowsCancellationByApp": true,
"externalSaleAvailable": true,
"acceptEnrollment": true,
"enrollmentRequired": true
}
]Modified at 2026-05-15 04:38:45