Obter informações básicas do membro

Descrição

Esse endpoint permite obter informações básicas do aluno, mas não retorna informações sensíveis.

🛂 A permissão no EVO que libera o acesso a este endpoint é o Cliente - Consulta sem dados sensíveis.

🚧 OBS. Para que algum aluno seja retornado, é necessário passar pelo menos um dos parâmetros a seguir: email, documento, telefone ou idMember.
Disponível para uso com chave de acesso de filial e também com chave de acesso de ADM Geral.

🔑 Parâmetro de Consulta (Query Param)

Parâmetro	Tipo	Obrigatório	Descrição
email	string	Não	Email do membro.
document	string	Não	Documento do membro.
phone	string	Não	Celular do membro.
idMember	int32	Não	ID do membro.
take	int32	Não	Total de valores para retornar. (Máximo 50)
skip	int32	Não	Total de valores para pular (ignorar).

📤 Estrutura de Resposta

Campo	Tipo	Descrição
`idMember`	number	Identificador único do membro.
`firstName`	string	Primeiro nome do membro.
`lastName`	string	Sobrenome do membro.
`registerName`	string	Nome registrado no cadastro.
`registerLastName`	string	Sobrenome registrado no cadastro.
`usePreferredName`	boolean	Indica se o sistema deve utilizar o nome preferencial.
`registerDate`	datetime	Data de cadastro do membro.
`idBranch`	number	Identificador da unidade associada ao membro.
`branchName`	string	Nome da unidade associada ao membro.
`accessBlocked`	boolean	Indica se o acesso do membro está bloqueado.
`blockedReason`	string	Motivo do bloqueio de acesso, quando aplicável.
`gender`	string	Gênero do membro.
`birthDate`	datetime	Data de nascimento do membro.
`accessCardNumber`	string	Número do cartão de acesso do membro.
`membershipStatus`	string	Status geral da associação do membro.
`penalized`	boolean	Indica se o membro está penalizado.
`status`	string	Status do membro no sistema.
`contacts`	array	Lista de contatos do membro. (ver detalhes mais abaixo)
`memberships`	array	Lista de associações (planos/contratos) do membro. (ver detalhes mais abaixo)
`lastAccessDate`	datetime	Data do último acesso do membro.
`idEmployeeConsultant`	number	Identificador do funcionário consultor associado ao membro.
`nameEmployeeConsultant`	string	Nome do funcionário consultor associado ao membro.
`idEmployeeInstructor`	number	Identificador do funcionário instrutor associado ao membro.
`nameEmployeeInstructor`	string	Nome do funcionário instrutor associado ao membro.
`idEmployeePersonalTrainer`	number	Identificador do personal trainer associado ao membro.
`nameEmployeePersonalTrainer`	string	Nome do personal trainer associado ao membro.
`photoUrl`	string	URL da foto do membro.
`idMemberMigration`	string	Identificador de migração do membro.
`responsibles`	array	Lista de responsáveis vinculados ao membro. (ver detalhes mais abaixo)
`tokenGympass`	string	Token de integração com Gympass.
`personalTrainer`	boolean	Indica se o membro possui personal trainer.
`personalType`	string	Tipo de personal associado ao membro.

🧩 Objeto de `contacts`

Campo	Tipo	Descrição
`idPhone`	number	Identificador do telefone.
`idMember`	number	Identificador do membro associado ao contato.
`idEmployee`	number	Identificador do funcionário associado ao contato.
`idProspect`	number	Identificador do prospect associado ao contato.
`idProvider`	number	Identificador do fornecedor associado ao contato.
`idContactType`	number	Identificador do tipo de contato.
`contactType`	string	Descrição do tipo de contato.
`ddi`	string	Código DDI do telefone.
`description`	string	Descrição do contato (ex: número, observação).

🧩 Objeto de `memberships`

Campo	Tipo	Descrição
`idMember`	number	Identificador do membro.
`idMembership`	number	Identificador da associação.
`idMemberMembership`	number	Identificador do vínculo membro–associação.
`idMemberMembershipRenewed`	number	Identificador da associação renovada, quando aplicável.
`numMembers`	number	Quantidade de membros vinculados.
`startDate`	datetime	Data de início da associação.
`endDate`	datetime	Data de término da associação.
`name`	string	Nome da associação.
`cancelDate`	datetime	Data de cancelamento.
`cancelDateOn`	datetime	Data efetiva do cancelamento.
`cancelCreationDate`	datetime	Data de criação do cancelamento.
`membershipStatus`	string	Status da associação.
`valueNextMonth`	number	Valor previsto para o próximo mês.
`nextCharge`	datetime	Data da próxima cobrança.
`nextDateSuspension`	datetime	Próxima data prevista de suspensão.
`idSale`	number	Identificador da venda associada.
`saleDate`	datetime	Data da venda.
`contractPrinting`	string	Informação de impressão de contrato.
`freezes`	array	Lista de congelamentos da associação. (ver detalhes mais abaixo)
`idCategoryMembership`	number	Identificador da categoria da associação.
`numberSuspensionTimes`	number	Número de suspensões realizadas.
`maxSuspensionDays`	number	Máximo de dias permitidos para suspensão.
`minimumSuspensionDays`	number	Mínimo de dias permitidos para suspensão.
`disponibleSuspensionDays`	number	Dias de suspensão disponíveis.
`disponibleSuspensionTimes`	number	Quantidade de suspensões disponíveis.
`daysLeftToFreeze`	number	Dias restantes para congelamento.
`loyaltyEndDate`	datetime	Data final do período de fidelidade.
`assessmentEndDate`	datetime	Data final da avaliação.
`acceptanceDate`	datetime	Data de aceite do contrato.
`flAllowLocker`	boolean	Indica se permite uso de armário.
`flAdditionalMembership`	boolean	Indica se é associação adicional.
`bioimpedanceAmount`	number	Quantidade de bioimpedâncias disponíveis.
`signedTerms`	boolean	Indica se os termos foram assinados.
`originalValue`	number	Valor original da associação.
`allowLesMills`	boolean	Indica se permite acesso ao Les Mills.
`allowsCancellationByApp`	boolean	Indica se permite cancelamento pelo aplicativo.
`contractSigningUrl`	string	URL para assinatura do contrato.
`limitless`	boolean	Indica se a associação é ilimitada.
`weeklyLimit`	number	Limite semanal de sessões.
`concludedSessions`	number	Sessões concluídas.
`pendingSessions`	number	Sessões pendentes.
`scheduledSessions`	number	Sessões agendadas.
`pendingRepositions`	number	Reposições pendentes.
`repositionsTotal`	number	Total de reposições.
`bonusSessions`	number	Sessões bônus.
`sessions`	array	Lista de sessões da associação. (ver detalhes mais abaixo)

🧩 Objeto de `memberships.freezes`

Campo	Tipo	Descrição
`startSuspend`	datetime	Data de início da suspensão.
`endSuspend`	datetime	Data de término da suspensão.
`unlockDate`	datetime	Data de liberação da suspensão.
`idEmployee`	number	Identificador do funcionário responsável.
`reason`	string	Motivo da suspensão.
`flUseMembershipFreezeDays`	boolean	Indica se utiliza dias de congelamento da associação.
`daysFreeze`	number	Quantidade de dias congelados.
`idFreeze`	number	Identificador do congelamento.

🧩 Objeto de `memberships.sessions`

Campo	Tipo	Descrição
`idSession`	number	Identificador da sessão.
`expirationDate`	datetime	Data de expiração da sessão.
`flBonusSession`	boolean	Indica se é uma sessão bônus.

🧩 Objeto de `responsibles`

Campo	Tipo	Descrição
`idResponsible`	number	Identificador do responsável.
`idMember`	number	Identificador do membro associado.
`name`	string	Nome do responsável.
`email`	string	E-mail do responsável.
`phone`	string	Telefone do responsável.
`observation`	string	Observações sobre o responsável.
`idMemberResponsible`	number	Identificador do vínculo membro–responsável.
`acessFiti`	boolean	Indica se possui acesso ao Fiti.
`financialResponsible`	boolean	Indica se é responsável financeiro.

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",
    "gender": "string",
    "birthDate": "2019-08-24T14:15:22.123Z",
    "accessCardNumber": "string",
    "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",
    "idEmployeeConsultant": 0,
    "nameEmployeeConsultant": "string",
    "idEmployeeInstructor": 0,
    "nameEmployeeInstructor": "string",
    "idEmployeePersonalTrainer": 0,
    "nameEmployeePersonalTrainer": "string",
    "photoUrl": "string",
    "idMemberMigration": "string",
    "responsibles": [
        {
            "idResponsible": 0,
            "idMember": 0,
            "name": "string",
            "email": "string",
            "phone": "string",
            "observation": "string",
            "idMemberResponsible": 0,
            "acessFiti": true,
            "financialResponsible": true
        }
    ],
    "tokenGympass": "string",
    "personalTrainer": true,
    "personalType": "string"
}

🟠400Bad Request

Get basic member information.

Obter informações básicas do membro#

Descrição#

🔑 Parâmetro de Consulta (Query Param)#

📤 Estrutura de Resposta#

🧩 Objeto de contacts#

🧩 Objeto de memberships#

🧩 Objeto de memberships.freezes#

🧩 Objeto de memberships.sessions#

🧩 Objeto de responsibles#

Requisição