Skip to main content
GET
As conversas do club — o Inbox

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

filter
enum<string>

O recorte da caixa. open é o que não está resolvido; unread, pending e saved são recortes dele; resolved é o que foi resolvido depois da última fala do aluno.

Available options:
open,
unread,
pending,
saved,
resolved
origin
enum<string>

Onde a conversa acontece — embaixo de uma aula ou de um post da comunidade.

Available options:
lesson,
post
q
string

Um trecho do nome de quem abriu a conversa, ou do que se falou nela.

Required string length: 1 - 200
limit
integer
default:30
Required range: 1 <= x <= 100
page
integer
default:1
Required range: x >= 1

Response

As conversas

data
object[]
required
total
integer
required
unread
integer
required

Quantas conversas abertas estão por ler, qualquer que seja o filtro.