Skip to main content
GET
Os agentes do club

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

q
string

Busca no nome.

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

Um ou vários (status=draft&status=scheduled). Ausente traz o que está DE PÉ — no ar, agendado e rascunho —, nunca o arquivado, a não ser com include_archived.

O estado do agente, derivado de published_at e archived: live responde no classroom, scheduled tem published_at no futuro, draft não tem published_at.

Available options:
live,
scheduled,
draft,
archived
include_archived
boolean
default:false

Sem status, traz também os arquivados. Com status, não muda nada.

limit
integer
default:20
Required range: 1 <= x <= 100
page
integer
default:1
Required range: x >= 1

Response

A página pedida

data
object[]
required
total
integer
required

Quantos agentes o recorte tem, além desta página.

counts
object
required

Quantos agentes o CLUB tem em cada estado, fora do recorte.