Listar turmas

Escopo: classes:read — Turmas e seus alunos (nome, aniversário, contato, assinatura e situação de pagamento).

Todas as turmas do estabelecimento, por nome. Sem paginação: a lista inteira vem numa resposta.

parâmetro
includeDeletedtrue inclui as turmas excluídas (enabled: false). Padrão false. Aceita true/false/1/0; outro valor é 400
bizIduid do estabelecimento. Dispensável com chave exclusiva de um estabelecimento; obrigatório nas demais

Campos

  • teacherName: nome do professor como digitado no cadastro da turma (não há cadastro de professor); null se vazio.
  • status: ACTIVE ou DELETED (excluída no app — só vem com includeDeleted=true). enabled é o mesmo dado em booleano.
  • schedule.days: SUN … SAT, em ordem. startTime/endTime em HH:MM no fuso do estabelecimento; endTime passa da meia-noite quando a aula atravessa o dia, e vem null sem duração cadastrada.
  • studentIds: ids dos alunos matriculados (os mesmos que o app usa para contar as vagas).
  • capacity: vagas da turma, compartilhadas entre alunos, Gympass e TotalPass; null = sem limite.
  • gympass / totalpass: a turma recebe reservas por esse parceiro.
  • linkedToAgenda: a turma ocupa uma agenda do estabelecimento (resourceId, o mesmo id de Listar agendas). resourceName vem null se a agenda foi apagada.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

uid do estabelecimento. Dispensável com chave exclusiva de um estabelecimento; obrigatório nas demais.

boolean
Defaults to false

true inclui as turmas excluídas. Aceita true/false/1/0.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json