Get Memberships

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âmetroTipoObrigatórioDescrição
idMembershipintNãoFiltra pelo ID do membership específico.
namestringNãoFiltra pelo nome do contrato.
idBranchintNãoFiltra pelo ID da filial. Ignorado se a chave de API não for multifilial.
takeintNãoNúmero total de registros a serem retornados (máximo: 50). Padrão: 25.
skipintNãoQuantidade de registros a serem ignorados (para paginação). Padrão: 0.
activebooleanNãoFiltra por contratos ativos ou inativos.
updateDatestring (ISO)NãoFiltra contratos atualizados a partir desta data (yyyy-mm-dd).
showAccessBranchesbooleanNãoExibe as filiais em que o contrato garante acesso. Padrão: false.
showOnlineSalesObservationbooleanNãoExibe observações referentes à venda online. Padrão: false.
showActivitiesGroupsbooleanNãoExibe 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
  }
]

Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!