> ## Documentation Index > Fetch the complete documentation index at: https://docs.useweve.com/llms.txt > Use this file to discover all available pages before exploring further. # Listar alunos > Nome e e-mail; exige administrar o club. ## OpenAPI ````yaml GET /v1/clubs/{clubId}/students openapi: 3.0.3 info: title: weve API description: > Contrato entre a API Go e o dashboard. **Este arquivo é a fonte de verdade**: os tipos e a interface de servidor em Go, e o client TypeScript, são todos gerados daqui (`make openapi`). Handler que divergir da interface não compila. A superfície interna (`/internal/*`) fica de fora de propósito: é acesso de máquina, protegido por segredo dedicado, e não é contrato de cliente. version: 0.2.0 servers: - url: https://api.useweve.com description: produção - url: http://localhost:8080 description: desenvolvimento security: [] tags: - name: health - name: session - name: account - name: clubs - name: members - name: webhooks - name: outgoing-webhooks - name: sales-platforms - name: catalog - name: content - name: classroom - name: community - name: mentorships - name: agents - name: lives - name: students - name: auth - name: campaigns - name: workflows - name: email - name: exports - name: certificates - name: terms - name: mcp - name: gamification - name: support - name: help paths: /v1/clubs/{clubId}/students: parameters: - $ref: '#/components/parameters/OrgId' get: tags: - students summary: Alunos do club description: | A lista de quem administra: nome e e-mail. É dado pessoal, então exige permissão de administração do club — pertencer ao club não basta. Busca por prefixo de e-mail ou trecho do nome; paginado. operationId: listStudents parameters: - name: search in: query required: false schema: type: string maxLength: 200 - name: exclude_admins in: query required: false description: | Deixa de fora as contas de aluno de quem ADMINISTRA o club — as que `POST /v1/clubs/{clubId}/classroom-session` cria para a própria pessoa ver o classroom. Elas não são matrícula de ninguém, e é o que a busca de "entrar como aluno" pede. O filtro mora aqui, e não na tela, porque a diferença é uma coluna que o contrato não conta: `StudentSummary` não diz quem, entre os alunos, também administra o club. schema: type: boolean default: false - name: include_removed in: query required: false description: | Traz também as contas anonimizadas a pedido (`anonymized`). Fora delas por padrão: numa lista de pessoas, uma conta removida é uma lápide com nome de ninguém. Quem procura uma conta específica no suporte liga o filtro. schema: type: boolean default: false - name: segment in: query required: false description: | O recorte da tela de Membros. `at_risk` é o `engagement` frio — quem não aparece há mais de uma semana; `new` é quem se cadastrou nos últimos sete dias; `completed` é quem já terminou ao menos UM curso inteiro (todas as aulas publicadas dele). Um curso, e não tudo o que tem acesso: quem assina o club inteiro nunca terminaria "tudo", e a aba ficaria vazia para sempre. schema: type: string enum: - all - at_risk - new - completed default: all - name: tag_id in: query required: false description: Só quem tem esta tag. schema: type: string format: uuid - name: last_seen in: query required: false description: | Filtra por quando a pessoa esteve no classroom pela última vez. `stale` inclui quem nunca entrou: a pergunta é de quem não se sabe nada há uma semana, e nunca visto é o caso extremo dela. schema: type: string enum: - any - last_7_days - last_30_days - stale default: any - name: limit in: query required: false schema: type: integer minimum: 1 maximum: 100 default: 25 - name: page in: query required: false schema: type: integer minimum: 1 default: 1 responses: '200': description: A página pedida content: application/json: schema: $ref: '#/components/schemas/StudentSummaryList' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '422': $ref: '#/components/responses/UnprocessableEntity' '500': $ref: '#/components/responses/InternalError' security: - userSession: [] components: parameters: OrgId: name: clubId in: path required: true description: > 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. schema: type: string format: uuid schemas: StudentSummaryList: type: object required: - data - total - engagement properties: data: type: array items: $ref: '#/components/schemas/StudentSummary' total: description: Quantos alunos o recorte tem, além desta página. type: integer engagement: $ref: '#/components/schemas/StudentEngagementCounts' StudentSummary: type: object required: - id - name - email - verified - has_password - anonymized - comments_muted - created_at properties: id: type: string format: uuid name: type: string email: type: string format: email document: description: | CPF (ou o documento que a plataforma de venda informou). Chega da compra e pode ser corrigido aqui; é o que dá peso à marca d'água do PDF, porque nome se repete e documento não. type: string verified: type: boolean has_password: type: boolean description: >- Falso na conta criada por compra ou convite que ainda não resgatou o link. anonymized: type: boolean description: Conta removida a pedido; nome e e-mail já não são os da pessoa. comments_muted: type: boolean description: | Silenciado nos comentários do club: continua assistindo ao que comprou, e não escreve, não responde e não reage. created_at: type: string format: date-time last_seen_at: description: | A última vez que a pessoa esteve no classroom. Ausente é "nunca desde que isto passou a ser registrado" — a conta criada pela compra e ainda sem senha é o caso comum. type: string format: date-time recent_lessons: description: | Quantas aulas ele concluiu nos últimos sete dias — o RITMO, que é o que a régua do calor lê. Não existe aqui uma "fração do curso" porque ela não significa a mesma coisa em todo club: num catálogo de quarenta cursos, quem terminou três inteiros aparece com 8%, igual a quem não fez nada. A fração é por CURSO, e vive em `StudentCourse`. Só a LISTAGEM e o DETALHE trazem este campo, o `has_access` e o `engagement` — é onde a régua é calculada. type: integer tags: description: | As tags da pessoa, em ordem alfabética. Só a LISTAGEM e o DETALHE trazem este campo. type: array items: $ref: '#/components/schemas/StudentTagRef' has_access: description: | Tem ao menos uma matrícula ativa, ou seja: há o que estudar hoje. Falso é um caso a resolver — a conta existe e não tem nada pela frente —, e não um zero a mais numa coluna de progresso. type: boolean engagement: $ref: '#/components/schemas/StudentEngagement' StudentEngagementCounts: description: | Quantas pessoas em cada faixa. Mede o CLUB inteiro, não o recorte pedido: sob a aba "Em risco" um termômetro do recorte diria sempre 100% frio, que é a pergunta respondendo a si mesma. Contas removidas ficam de fora. type: object required: - cold - warm - active - engaged properties: cold: type: integer warm: type: integer active: type: integer engaged: type: integer ErrorEnvelope: type: object description: >- Envelope único de erro da API. O `code` é o contrato com o cliente — a `message` é diagnóstico, e pode mudar. required: - error properties: error: type: object required: - code properties: code: type: string message: type: string StudentTagRef: type: object required: - id - name properties: id: type: string format: uuid name: type: string StudentEngagement: description: | A faixa de calor de um aluno, na régua da tela de Membros: `cold` é quem não aparece há mais de uma semana (ou nunca apareceu), `warm` há mais de dois dias, `active` é quem esteve aqui nos últimos dois dias e `engaged`, quem esteve E está andando — três aulas ou mais concluídas na última semana. O que separa `active` de `engaged` é RITMO, e não fração do catálogo: exigir "60% do que tem em mãos" esvaziava a faixa em todo club com muitos cursos. A régua mora no banco (`student_engagement`), para a lista, a contagem do termômetro e o filtro das abas nunca discordarem. type: string enum: - cold - warm - active - engaged responses: Unauthorized: description: Sessão ausente, expirada ou revogada content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' Forbidden: description: > A sessão é válida, mas não age nesta organização. É a mesma resposta para uma organização que não existe — distinguir as duas deixaria enumerar organizações alheias. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' UnprocessableEntity: description: Campos obrigatórios ausentes ou inválidos content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' InternalError: description: >- Falha inesperada. O corpo nunca traz o erro real — ele fica no log e no rastreamento. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' securitySchemes: userSession: type: http scheme: bearer description: | 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. ````