Get member profile

Obter Perfil de Membro

Descrição

Endpoint para obter o perfil completo de um membro, incluindo dados pessoais, contatos, responsáveis e contratos.

Parâmetros de Requisição

ParâmetroTipoObrigatórioDescrição
idMemberint32SimID do membro para consulta
showMembershipsbooleanNãoExibe dados de contratos do membro (default: false)
showsResponsiblesbooleanNãoExibe dados de responsáveis (financeiro, acesso, etc.) do membro (default: false)

Estrutura da Resposta

ParâmetroTipoDescrição
idMemberintIdentificador do membro
photostringURL da foto do membro
firstNamestringPrimeiro nome do membro
lastNamestringSobrenome do membro
registerDatestring (date-time)Data de registro do membro
idBranchintID da unidade/filial
branchNamestringNome da unidade/filial
accessBlockedbooleanIndica se o acesso está bloqueado
blockedReasonstringMotivo do bloqueio, se aplicável
documentstringDocumento principal (ex: RG, CPF)
documentIdstringID do documento
maritalStatusstringEstado civil
genderstringGênero
birthDatestring (date-time)Data de nascimento
countrystringPaís
addressstringEndereço completo
statestringEstado
citystringCidade
passportstringNúmero do passaporte
zipCodestringCódigo postal
complementstringComplemento do endereço
neighborhoodstringBairro
accessCardNumberstringNúmero do cartão de acesso
numberstringNúmero residencial
idMemberMigrationstringID para migração do membro (se aplicável)
taxDataobjectDados fiscais do membro (detalhes abaixo)
emailstringEmail do membro
slugstringIdentificador amigável (slug)
penalizedbooleanIndica se o membro está penalizado
idBranchTokenstringToken da unidade
totalFitCoinsintTotal de moedas FitCoins do membro
membershipStatusstringStatus atual do contrato/membro
contactsarrayLista de contatos (detalhes abaixo)
lastAccessDatestring (date-time)Última data de acesso
responsiblesarrayLista de responsáveis (detalhes abaixo)
membershipsarrayLista de associações do membro (detalhes abaixo)
registrationKindstringTipo de registro do membro
membershipobjectDetalhes do contrato principal (detalhes abaixo)

Detalhes de Objetos Aninhados

taxData (Dados fiscais)

ParâmetroTipoDescrição
firstNamestringPrimeiro nome fiscal
lastNamestringSobrenome fiscal
dnistringDocumento nacional de identidade
cuitstringCUIT/CNPJ (Cadastro fiscal)
taxTypeintTipo de imposto

contacts (Contatos)

ParâmetroTipoDescrição
idPhoneintID do telefone
idMemberintID do membro
idEmployeeintID do funcionário (se aplicável)
idProspectintID do prospect (se aplicável)
idProviderintID do provedor (se aplicável)
idContactTypeintTipo do contato
contactTypestringDescrição do tipo do contato
ddistringCódigo DDI do telefone
descriptionstringNúmero ou descrição do contato

responsibles (Responsáveis)

ParâmetroTipoDescrição
idResponsibleintID do responsável
idMemberintID do membro relacionado
namestringNome do responsável
cpfstringCPF do responsável
emailstringEmail do responsável
phonestringTelefone do responsável
observationstringObservações adicionais
idMemberResponsibleintID do membro responsável
acessFitibooleanIndica acesso ao sistema Fiti
financialResponsiblebooleanIndica se é responsável financeiro

memberships (Contratos)

ParâmetroTipoDescrição
idMemberintID do membro
idMembershipintID do contrato
idMemberMembershipintID do contrato do membro
idMemberMembershipRenewedintID da renovação do contrato
numMembersintNúmero de membros na contrato
startDatestring (date-time)Data de início do contrato
endDatestring (date-time)Data de término do contrato
namestringNome do contrato
cancelDatestring (date-time)Data de cancelamento
cancelDateOnstring (date-time)Data efetiva do cancelamento
cancelCreationDatestring (date-time)Data de criação do cancelamento
membershipStatusstringStatus do contrato
valueNextMonthnumberValor da próxima mensalidade
nextChargestring (date-time)Próxima cobrança
idSaleintID da venda
saleDatestring (date-time)Data da venda
contractPrintingstringInformações do contrato impressas
freezesarrayPeríodos de suspensão do contrato (detalhes abaixo)
idCategoryMembershipintID da categoria do contrato
numberSuspensionTimesintNúmero de vezes que foi suspensa
maxSuspensionDaysintMáximo de dias de suspensão permitidos
minimumSuspensionDaysintMínimo de dias para suspensão
disponibleSuspensionDaysintDias de suspensão disponíveis
disponibleSuspensionTimesintQuantidade de suspensões disponíveis
daysLeftToFreezeintQuantidade de dias permitidos para a suspensão do contrato
loyaltyEndDatestring (date-time)Data fim do programa de fidelidade
assessmentEndDatestring (date-time)Data fim da avaliação
acceptanceDatestring (date-time)Data de aceitação
flAllowLockerbooleanPermite uso de armário
flAdditionalMembershipbooleanIndica contrato adicional
bioimpedanceAmountnumberQuantidade de bioimpedância
signedTermsbooleanTermos assinados
allowLesMillsbooleanPermite uso de Les Mills
allowsCancellationByAppbooleanPermite cancelamento pelo app
limitlessbooleanAcesso ilimitado
weeklyLimitintLimite semanal
concludedSessionsintSessões concluídas
pendingSessionsintSessões pendentes
scheduledSessionsintSessões agendadas
pendingRepositionsintReposições pendentes
repositionsTotalintTotal de reposições
bonusSessionsintSessões bônus
sessionsarrayLista de sessões (detalhes abaixo)

freezes (Períodos de Suspensão)
ParâmetroTipoDescrição
startSuspendstring (date-time)Data de início da suspensão
endSuspendstring (date-time)Data de fim da suspensão
unlockDatestring (date-time)Data para desbloqueio
idEmployeeintID do funcionário que registrou
reasonstringMotivo da suspensão
flUseMembershipFreezeDaysbooleanIndica se usa dias de suspensão
daysFreezeintQuantidade de dias suspensos
idFreezeintID da suspensão

sessions (Sessões do Contrato)
ParâmetroTipoDescrição
idSessionintID da sessão
expirationDatestring (date-time)Data de expiração da sessão
flBonusSessionbooleanIndica se é uma sessão bônus

membership (Contrato principal)

ParâmetroTipoDescrição
idMembershipintID do contrato
idMemberMembershipintID do contrato do membro
idMemberMembershipRenewedintID da renovação do contrato
numMembersintNúmero de membros
startDatestring (date-time)Data de início do contrato
endDatestring (date-time)Data de término do contrato
namestringNome do contrato
saleDatestring (date-time)Data da venda
timeZonestringFuso horário
freezebooleanIndica se está congelada
membershipStatusstringStatus do contrato
membershipTypestringTipo do contrato
flAdditionalMembershipbooleanIndica contrato adicional
flAllowLockerbooleanPermite uso de armário
idCategoryMembershipintID da categoria do contrato

Exemplo de Resposta

A resposta retorna os dados completos do membro solicitado, com campos condicionais de acordo com os parâmetros showMemberships e showsResponsibles.

{
  "idMember": 987654,
  "photo": "https://cdn.exemplo.com/fotos/987654.jpg",
  "firstName": "João",
  "lastName": "Silva",
  "registerDate": "2023-02-10T15:00:00Z",
  "idBranch": 12,
  "branchName": "Unidade Centro",
  "accessBlocked": false,
  "blockedReason": null,
  "document": "123.456.789-00",
  "birthDate": "1990-01-01T00:00:00Z",
  "gender": "Masculino",
  "email": "[email protected]",
  "accessCardNumber": "A00123",
  "contacts": [
    {
      "idPhone": 1,
      "idContactType": 1,
      "contactType": "Celular",
      "ddi": "+55",
      "description": "(11) 99999-9999"
    }
  ],
  "responsibles": [
    {
      "idResponsible": 1,
      "name": "Maria Silva",
      "cpf": "123.123.123-12",
      "email": "[email protected]",
      "phone": "(11) 98888-8888",
      "observation": "Mãe do aluno",
      "financialResponsible": true,
      "acessFiti": false
    }
  ],
  "memberships": [
    {
      "idMembership": 321,
      "name": "Plano Anual",
      "membershipStatus": "Ativo",
      "startDate": "2024-03-01T00:00:00Z",
      "endDate": "2025-03-01T00:00:00Z",
      "cancelDate": null,
      "nextCharge": "2024-08-01T00:00:00Z",
      "saleDate": "2024-02-25T12:00:00Z",
      "signedTerms": true,
      "flAllowLocker": true,
      "sessions": [
        {
          "idSession": 12345,
          "expirationDate": "2024-09-01T00:00:00Z",
          "flBonusSession": false
        }
      ]
    }
  ],
  "membershipStatus": "Ativo",
  "slug": "joao-silva"
}

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