> ## 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. # Ler aluno > Matrículas e o histórico de acesso. ## OpenAPI ````yaml GET /v1/clubs/{clubId}/students/{studentId} 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/{studentId}: parameters: - $ref: '#/components/parameters/OrgId' - $ref: '#/components/parameters/StudentId' get: tags: - students summary: Um aluno, com matrículas e histórico de acesso description: | Tudo que o suporte precisa: cada matrícula com origem, prazo e estado, e o ledger de acesso — por que tem, por que perdeu, quem deu. Exige permissão de administração do club. operationId: getStudent responses: '200': description: O aluno content: application/json: schema: $ref: '#/components/schemas/StudentDetailResponse' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '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 StudentId: name: studentId in: path required: true schema: type: string format: uuid schemas: StudentDetailResponse: type: object required: - data properties: data: $ref: '#/components/schemas/StudentDetail' StudentDetail: allOf: - $ref: '#/components/schemas/StudentSummary' - type: object required: - enrollments - access_events - summary properties: enrollments: type: array items: $ref: '#/components/schemas/Enrollment' access_events: type: array items: $ref: '#/components/schemas/AccessEvent' summary: $ref: '#/components/schemas/StudentAccountSummary' 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 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' Enrollment: type: object required: - id - delivery_id - delivery_name - source - active - starts_at - created_at properties: id: type: string format: uuid delivery_id: type: string format: uuid delivery_name: type: string source: $ref: '#/components/schemas/EnrollmentSource' active: type: boolean description: Não revogada e dentro do prazo. starts_at: type: string format: date-time expires_at: type: string format: date-time description: Ausente é vitalício. revoked_at: type: string format: date-time revoke_reason: type: string cohort_id: type: string format: uuid description: A turma em que a matrícula entrou, quando entrou em alguma. cohort_name: type: string created_at: type: string format: date-time AccessEvent: type: object required: - id - enrollment_id - kind - occurred_at properties: id: type: string format: uuid enrollment_id: type: string format: uuid kind: type: string enum: - granted - extended - shortened - revoked - restored - moved effective_expires_at: type: string format: date-time reason: type: string actor_user_id: type: string format: uuid description: >- Quem administrava, quando foi uma pessoa. Ausente quando foi a plataforma ou o próprio aluno. platform_event_id: type: string format: uuid occurred_at: type: string format: date-time StudentAccountSummary: description: | Os números da página do aluno: o que ele comprou, até quando o acesso vale e o que já conquistou. Vem no detalhe, e não na listagem, porque são quatro agregações por PESSOA — numa página de 25 seriam cem. type: object required: - purchases - paid_cents - refunded_cents - certificates - lifetime_access - active_subscription - submissions - pending_submissions - quizzes - comments - posts - mentorships - agent_conversations - emails - automations properties: emails: description: >- E-mails do club endereçados a ela (campanha, automação, aviso de live). type: integer automations: description: Vezes em que ela entrou numa automação. type: integer email_suppression: description: > Por que o club NÃO manda e-mail para ela, quando não manda: ela se descadastrou, marcou como spam, ou o endereço devolve (este vale para todos os clubs). Ausente é que o e-mail chega. type: string enum: - unsubscribed - complained - bounced purchases: description: Compras pagas, sem contar as reembolsadas. type: integer submissions: description: | Entregas que a pessoa mandou (de blocos que ainda estão na aula). As contagens desta parte existem para a página saber quais seções desenhar sem buscar cada lista: seção sem nada não aparece. type: integer pending_submissions: description: Das entregas, quantas esperam correção. type: integer quizzes: description: Blocos de quiz (ainda na aula) que ela tentou ao menos uma vez. type: integer comments: description: Comentários vivos que ela escreveu, nas aulas e nos posts. type: integer posts: description: Posts vivos que ela publicou na comunidade. type: integer mentorships: description: >- Mentorias em que ela aparece no quadro — a mesma regra de `listStudentMentorships`. type: integer agent_conversations: description: Conversas com agentes, fora das aulas. type: integer paid_cents: description: O total pago, em centavos, das compras que valeram. type: integer refunded_cents: description: Quanto voltou. Ausente de `paid_cents`, e não descontado dele. type: integer certificates: description: Certificados emitidos e não revogados. type: integer lifetime_access: description: Tem ao menos uma matrícula ativa sem prazo. type: boolean active_subscription: description: Tem assinatura em dia (ou em carência). type: boolean access_until: description: | O maior prazo entre as matrículas ativas. Ausente quando não há acesso ativo, ou quando `lifetime_access` já diz que não há prazo. type: string format: date-time 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 EnrollmentSource: type: string enum: - purchase - subscription - manual - invitation - import - open_access - registration_link 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' NotFound: description: Recurso não encontrado 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. ````