Obter Membros

Descrição

Retorna uma lista de membros. Utilizado para acessar informações relacionadas aos alunos da academia, podendo aplicar filtros diversos por nome, documento, datas de registro, status, entre outros.

🚧 OBS. Para que o campo status seja retornado corretamente, é necessário definir showMemberships = true.
Disponível para uso com chave de acesso de filial e também com chave de acesso de ADM Geral.

🔑 Parâmetros da Consulta (Query Params)

Parâmetro	Tipo	Obrigatório	Descrição
name	string	Não	Filtra os membros pelo nome.
email	string	Não	Filtra os membros pelo e-mail.
document	string	Não	Filtra os membros pelo número do documento.
phone	string	Não	Filtra os membros pelo telefone ou celular. Ex.: 1112341234
conversionDateStart	date-time	Não	Filtra os membros pela data de conversão inicial. (Formato: yyyy-mm-dd)
conversionDateEnd	date-time	Não	Filtra os membros pela data de conversão final. (Formato: yyyy-mm-dd)
registerDateStart	date-time	Não	Filtra os membros pela data de cadastro inicial. (Formato: yyyy-mm-dd)
registerDateEnd	date-time	Não	Filtra os membros pela data de cadastro final. (Formato: yyyy-mm-dd)
membershipStartDateStart	date-time	Não	Filtra os membros pela data de início da adesão à matrícula. (Formato: yyyy-mm-dd)
membershipStartDateEnd	date-time	Não	Filtra os membros pela data de início da adesão à matrícula. (Formato: yyyy-mm-dd)
membershipCancelDateStart	date-time	Não	Filtra os membros pela data de cancelamento da adesão. (Formato: yyyy-mm-dd)
membershipCancelDateEnd	date-time	Não	Filtra os membros pela data de cancelamento da adesão. (Formato: yyyy-mm-dd)
status	int32	Não	Filtra os membros pelo status: 1 - Ativo (inclui Suspensos e Vips), 2 - Inativo
tokenGympass	string	Não	Filtra pelo token do membro no Gympass.
take	int32	Não	Define o número total de registros a retornar. O valor padrão é 50. Máximo de 50.
skip	int32	Não	Define o número de registros a serem pulados. O valor padrão é 0.
idsMembers	string	Não	Filtra por IDs de membros. Adicione os IDs dos membros separados por vírgula (Ex.: 1,2,3)
onlyPersonal	boolean	Não	Define se deve mostrar apenas os treinadores pessoais. O valor padrão é `false`.
personalType	int32	Não	Filtra pelo tipo de personal trainer: 1 - Interno, 2 - Externo
showActivityData	boolean	Não	Define se deve exibir dados de atividade dos membros. O valor padrão é `false`.
idBranch	int32	Não	Filtra pelo ID da filial do membro. (Disponível apenas ao usar uma chave multilocation)
updateDate	date-time	Não	Filtra membros com dados de atualização maiores ou iguais à data fornecida. (Formato: yyyy-mm-dd)
showMemberships	boolean	Não	Define se deve exibir dados de matrícula dos membros. O valor padrão é `false`.
showsResponsibles	boolean	Não	Define se deve mostrar os dados dos responsáveis pelo membro. O valor padrão é `false`.
membershipEndDateStart	string	Não	Filtra os membros pela data inicial do fim da matrícula. (Formato: yyyy-mm-dd)
membershipEndDateEnd	string	Não	Filtra os membros pela data final do fim da matrícula. (Formato: yyyy-mm-dd)
registerName	string	Não	Filtra os membros pelo nome de registro.

🔷 Enum de `status`

Código	Descrição
1	Membro Ativo (inclui suspensos e VIPs)
2	Membro Inativo

🔷 Enum de `personalType`

Descrição	Código
Interno	1
Externo	2

Basic Auth

Envie suas requisições HTTP com um cabeçalho

Authorization

que contenha a palavra Basic seguida por um espaço e uma string codificada em base64 username:password

Exemplo:

Authorization: Basic *****************

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200OK

application/json

Success

Body

Exemplo

{
    "idMember": 0,
    "firstName": "string",
    "lastName": "string",
    "registerName": "string",
    "registerLastName": "string",
    "usePreferredName": true,
    "registerDate": "2019-08-24T14:15:22.123Z",
    "idBranch": 0,
    "branchName": "string",
    "accessBlocked": true,
    "blockedReason": "string",
    "document": "string",
    "documentId": "string",
    "maritalStatus": "string",
    "gender": "string",
    "birthDate": "2019-08-24T14:15:22.123Z",
    "updateDate": "2019-08-24T14:15:22.123Z",
    "address": "string",
    "state": "string",
    "city": "string",
    "zipCode": "string",
    "complement": "string",
    "neighborhood": "string",
    "accessCardNumber": "string",
    "number": "string",
    "totalFitCoins": 0,
    "membershipStatus": "string",
    "penalized": true,
    "status": "string",
    "contacts": [
        {
            "idPhone": 0,
            "idMember": 0,
            "idEmployee": 0,
            "idProspect": 0,
            "idProvider": 0,
            "idContactType": 1,
            "contactType": "string",
            "ddi": "string",
            "description": "string"
        }
    ],
    "memberships": [
        {
            "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,
            "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
                }
            ]
        }
    ],
    "lastAccessDate": "2019-08-24T14:15:22.123Z",
    "conversionDate": "2019-08-24T14:15:22.123Z",
    "idEmployeeConsultant": 0,
    "nameEmployeeConsultant": "string",
    "idEmployeeInstructor": 0,
    "nameEmployeeInstructor": "string",
    "idEmployeePersonalTrainer": 0,
    "nameEmployeePersonalTrainer": "string",
    "photoUrl": "string",
    "country": "string",
    "idMemberMigration": "string",
    "responsibles": [
        {
            "idResponsible": 0,
            "idMember": 0,
            "name": "string",
            "cpf": "string",
            "email": "string",
            "phone": "string",
            "observation": "string",
            "idMemberResponsible": 0,
            "acessFiti": true,
            "financialResponsible": true,
            "personType": "string",
            "document": "string",
            "cep": "string",
            "adress": "string",
            "number": "string",
            "complement": "string",
            "district": "string",
            "city": "string",
            "state": "string"
        }
    ],
    "gympassId": "string",
    "personalTrainer": true,
    "personalType": "string",
    "cref": "string",
    "crefExpirationDate": "2019-08-24T14:15:22.123Z",
    "codeTotalpass": "string",
    "userIdGurupass": "string",
    "clientWithPromotionalRestriction": true
}

🟠400Bad Request

Get members

Obter Membros#

Descrição#

🔑 Parâmetros da Consulta (Query Params)#

🔷 Enum de status#

🔷 Enum de personalType#