Get members

GET https://evo-integracao-api.w12app.com.br/api/v2/members

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.

Parâmetros da Consulta

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.

Tipos de (status)

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

Tipos de (personalType)

Descrição	Código
Interno	1
Externo	2

Exemplo de Resposta

JSON

[
  {
    "idMember": 123,
    "firstName": "João",
    "lastName": "Silva",
    "registerDate": "2025-06-01T10:00:00Z",
    "status": "Active",
    "document": "12345678900",
    "email": "[email protected]",
    "phone": "11912341234",
    "birthDate": "1990-01-01T00:00:00Z",
    "address": "Rua Exemplo, 123",
    "city": "São Paulo",
    "state": "SP",
    "zipCode": "01234567",
    "memberships": [
      {
        "idMembership": 456,
        "name": "Plano Mensal",
        "startDate": "2025-06-01T00:00:00Z",
        "endDate": "2025-07-01T00:00:00Z",
        "membershipStatus": "Ativo"
      }
    ],
    "responsibles": [
      {
        "name": "Maria Silva",
        "cpf": "98765432100",
        "email": "[email protected]",
        "financialResponsible": true
      }
    ],
    "photoUrl": "https://cdn.academia.com/foto123.jpg"
  }
]