> ## Documentation Index > Fetch the complete documentation index at: https://docs.weve.cx/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.weve.cx description: produção - url: http://localhost:8080 description: desenvolvimento security: [] tags: - name: health - name: session - name: account - name: clubs - name: members - name: webhooks - name: sales-platforms - name: catalog - name: content - name: classroom - name: students - name: auth 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 properties: enrollments: type: array items: $ref: '#/components/schemas/Enrollment' access_events: type: array items: $ref: '#/components/schemas/AccessEvent' 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 - 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. created_at: type: string format: date-time 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 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. ```` ## Related topics - [Ler curso](/api-reference/content/courses-get.md) - [Ler um evento](/api-reference/webhooks/events-get.md) - [Limites de uso](/essentials/rate-limits.md) - [Acesso ao classroom](/api-reference/clubs/classroom-session.md) - [Listar alunos](/api-reference/students/list.md)