Get activities schedule

Status:

Livre = 0,
Disponivel = 1,
Lotada = 2,
ReservaEncerrada = 3,
Restrita = 4,
Cadastrado = 5,
Finalizada = 6,
Cancelada = 7,
NaFila = 8,
LivreEncerrada = 10,
RestritaEncerrada = 11,
RestritaNaoPermiteParticipar = 12,
LotadaSemFilaEspera = 15

Obter Agenda de Atividades

Descrição

Recupera uma agenda detalhada de atividades, incluindo informações como data, hora, local, capacidade e detalhes específicos sobre o instrutor e a configuração da atividade.

Parâmetros de Consulta

Este endpoint pode incluir parâmetros opcionais para filtrar a agenda de atividades. Em um cenário de grande número de filiais, recomendamos informar o idBranch da filial associada às atividades desejadas. Continue lendo essa seção da documentação para mais detalhes sobre os parâmetros disponíveis.

ParâmetroTipoObrigatórioDescrição
idMemberint32NãoFiltra por membro
takeint32NãoTotal de registros a serem retornados
onlyAvailablesbooleanNãoFiltra por atividades disponíveis. false por padrão.
datedate-timeNãoFiltra por uma data específica.
showFullWeekbooleanNãoMostra todas as atividades da semana.
idBranchint32RecomendávelFiltra por filial.
idActivitiesstringNãoFiltra pelo ID de atividades. Informar os IDs separados por vírgulas.
idAudiencesstringNãoFiltra pelo ID de audiências. Informar os IDs separados por vírgulas.
idBranchTokenstringNãoFiltrar por filial diferente da atual.

Resposta

A resposta é um array de objetos de atividades agendadas com a seguinte estrutura:

CampoTipoDescrição
idConfigurationinteiroIdentificador único da configuração da atividade.
idActivityinteiroIdentificador único para a atividade.
idGroupActivityinteiroIdentificador do grupo de atividades ao qual pertence.
namestringNome da atividade.
descriptionstringDescrição detalhada da atividade.
imageUrlstringURL da imagem da atividade.
areastringÁrea onde a atividade será realizada.
idAreainteiroIdentificador da área da atividade.
capacityinteiroCapacidade máxima de participantes para a atividade.
ocupationinteiroQuantidade de vagas ocupadas.
allowChoosingSpotbooleanoIndica se é permitido escolher o local específico (true ou false).
startTimestringHora de início da atividade (formato HH:MM).
endTimestringHora de término da atividade (formato HH:MM).
bookingStartTimestringHora de início para reservas (formato HH:MM).
bookingEndTimestringHora de término para reservas (formato HH:MM).
instructorstringNome do instrutor responsável pela atividade.
instructorPhotostringURL da foto do instrutor.
activityDatedatetimeData da atividade (formato ISO 8601).
audiencestringPúblico-alvo da atividade.
idAudienceinteiroIdentificador do público-alvo.
codestringCódigo identificador da atividade.
confirmedbooleanoIndica se a atividade está confirmada (true ou false).
spotsarrayLista de assentos/vagas disponíveis para a atividade (detalhado abaixo).
periodizationarrayLista de configurações de periodização (detalhado abaixo).
statusinteiroCódigo de status da atividade.
statusNamestringNome do status da atividade.

Estrutura do Objeto spots

CampoTipoDescrição
numberinteiroNúmero do assento ou vaga.
availablebooleanoIndica se o assento está disponível (true ou false).
nameSpotstringNome ou identificação do assento.

Estrutura do Objeto periodization

CampoTipoDescrição
namestringNome da periodização.
characteristicsstringCaracterísticas específicas da periodização.
colorstringCódigo de cor associado à periodização.
intensityNumberinteiroNível de intensidade associado à periodização.
typestringTipo de periodização.

Status da atividade

StatusDescriçãoValor
LivreAula configurada como livre no sistema (Evo).0
DisponívelAula pode ser agendada.1
LotadaAula lotada, não é possível agendar, a fila de espera está ativa.2
Reserva EnceradaAula não pode mais ser agendada porque já passou do horário.3
RestritaAluno sem direito a participar, precisa comprar um contrato para ter direito.4
CadastradoAluno já está cadastrado na aula.5
FinalizadaAula marcada como finalizada no Evo.6
CanceladaAula cancelada no Evo.7
Na FilaAula estava lotada e o aluno entrou na fila de espera.8
Livre EncerradaAula configurada como livre no Evo e já foi finalizada.10
Restrita EncerradaAula restrita e já foi finalizada no Evo.11
Restrita Não Permite ParticiparAula não permite agendamento, apenas participação presencial.12
Lotada Sem Fila de EsperaAula lotada e não permite que o aluno entre na fila de espera.15

Estrutura do Enum Origin

ValorNomeDescrição
0RecepcaoAvulsoTipo de origem para recepção avulsa.
1RecepcaoSemanalTipo de origem para recepção semanal.
2MobileOrigem relacionada a dispositivos móveis.
3TotemOrigem associada ao uso de totens.
4MatriculaOrigem relacionada ao processo de matrícula.
5LinkOrigem associada a links compartilhados.
6GympassOrigem associada ao Gympass.
7ClassPassOrigem associada ao ClassPass.
8ImpressaoTreinoOrigem associada à impressão de treino.
9TotalPassOrigem relacionada ao TotalPass.
10ExternoOrigem de uma fonte externa.
11SeuGuruOrigem associada ao SeuGuru.
12MyWellnessOrigem relacionada ao MyWellness.

Exemplo de Requisição

{
  "idMember": 0,
  "take": 10,
  "onlyAvailables": false,
  "date": "2025-03-19T00:00:00",
  "showFullWeek": false,
  "idBranch": 123,
  "idActivities": "1,2,3",
  "idAudiences": "1,2",
  "idBranchToken": "abc123",
  "origin": 0
}
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!