Skip to main content
GET
A agenda de lives

Authorizations

Authorization
string
header
required

Token OPACO de sessão de quem administra, emitido por /v1/auth/admin/sign-in e verificado contra a nossa tabela — o mesmo desenho do studentSession, para a outra identidade.

É o esquema de quem ADMINISTRA — o dashboard. O aluno do classroom usa o studentSession; uma rota consumida pelos dois declara os dois esquemas, e o middleware aceita qualquer um deles. As duas credenciais são opacas e chegam pelo mesmo cabeçalho: quem as separa é a tabela em que cada uma existe.

O dashboard o guarda em cookie httpOnly, que o BFF troca pelo Authorization a cada chamada.

Path Parameters

clubId
string<uuid>
required

Id público da organização — o mesmo que GET /v1/me devolve em organization_id.

Na URL o recurso se chama club; no contrato e no domínio, organization. A divergência é deliberada: clubs é a palavra do produto, e a URL é o que as pessoas leem.

É o identificador do provedor de autenticação, e é assim de propósito: o cliente precisa nomear a organização ao pedir o token, e o token é o que prova o escopo. Um id só nosso obrigaria a traduzir um no outro antes de ter um token — e a tradução exigiria uma chamada escopada, que é justamente a que ainda não dá para fazer.

O uuid interno da organização não aparece no contrato: ele é o que as chaves estrangeiras do domínio referenciam, e continua sendo nosso.

Query Parameters

period
enum<string>

A aba da agenda. upcoming: scheduled, waiting ou live. past: ended. A cancelada fica fora das duas, a menos que se peça include_cancelled.

Available options:
upcoming,
past
q
string

Busca no título.

Maximum string length: 200
status
enum<string>[]

Um ou vários (status=draft&status=cancelled). Ausente traz a publicada e o rascunho — a cancelada só vem pedida, aqui ou por include_cancelled.

O filtro de estado da agenda, lido de cancelled_at e published_at: cancelled ganha de tudo, published é a publicação que já chegou, e o resto é draft — a agendada inclusive.

Available options:
published,
draft,
cancelled
provider
enum<string>[]

Um ou vários provedores (provider=youtube&provider=link).

Onde a transmissão acontece. livekit é a sala nossa — com palco, chat e gravação —; youtube e vimeo são tocados por embed no classroom; link é qualquer outra sala (Zoom, Meet), aberta fora.

Available options:
livekit,
youtube,
vimeo,
link
channel_id
string<uuid>
from
string<date-time>
to
string<date-time>
include_cancelled
boolean
default:false
limit
integer
Required range: 1 <= x <= 100
page
integer
Required range: x >= 1

Response

As lives

data
object[]
required
total
integer
required