Skip to main content
GET
As exportações 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

Trecho do nome ou começo do e-mail de QUEM PEDIU. É o único texto livre de um relatório — o tipo tem filtro próprio (kind).

Maximum string length: 200
segment
enum<string>
default:all

O recorte da tela de Relatórios. in_flight junta pending e running: quem pergunta "já saiu?" não distingue a fila do trabalho em curso. expired não tem aba e vive em all — a linha vencida é a trilha de quem exportou o quê, não algo a fazer.

Available options:
all,
in_flight,
ready,
failed
kind
enum<string>

O tipo do relatório, como o catálogo o entrega (GET .../export-kinds).

O que exportar. full é a exportação completa, um .zip com todos os outros tipos.

purchases e subscriptions foram DESCONTINUADOS e não aparecem mais em GET .../export-kinds: pedir um deles responde 422 (invalid_kind). Venda, valor e situação de cobrança nascem na plataforma de pagamento, e é lá que se concilia — a compra existe aqui para abrir o acesso. Os dois valores seguem no enum porque as exportações já pedidas continuam na lista enquanto duram.

Available options:
full,
students,
enrollments,
purchases,
subscriptions,
course_progress
created_from
string<date-time>

Pedidos a partir deste instante (inclusive).

created_until
string<date-time>

Pedidos feitos antes deste instante.

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

Response

A página pedida

data
object[]
required
total
integer
required