> ## 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. # Prontuário > O acesso, o crédito por fonte, o que está em aberto e a próxima sessão. ## OpenAPI ````yaml GET /v1/clubs/{clubId}/mentorships/{mentorshipId}/participants/{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: 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 paths: /v1/clubs/{clubId}/mentorships/{mentorshipId}/participants/{studentId}: parameters: - $ref: '#/components/parameters/OrgId' - $ref: '#/components/parameters/MentorshipId' - $ref: '#/components/parameters/StudentId' get: tags: - mentorships summary: O prontuário de um mentorado description: | A pessoa, o acesso, o mentor e a etapa, o crédito detalhado por FONTE (cada matrícula com a cota e o saldo dela, e cada concessão avulsa) e a próxima sessão. Aluno do club que não tem nem direito nem histórico na mentoria responde 404 `participant_not_found`. operationId: getMentorshipParticipant responses: '200': description: O mentorado content: application/json: schema: $ref: '#/components/schemas/MentorshipParticipantResponse' '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 MentorshipId: name: mentorshipId in: path required: true schema: type: string format: uuid StudentId: name: studentId in: path required: true schema: type: string format: uuid schemas: MentorshipParticipantResponse: type: object required: - data properties: data: $ref: '#/components/schemas/MentorshipParticipant' MentorshipParticipant: type: object required: - student_id - student_name - student_email - anonymized - has_access - credits - open_goals - open_tasks properties: student_id: type: string format: uuid student_name: type: string student_email: type: string format: email anonymized: type: boolean has_access: type: boolean access_until: type: string format: date-time mentor_user_id: type: string format: uuid mentor_name: type: string stage_id: type: string format: uuid stage_entered_at: type: string format: date-time credits: $ref: '#/components/schemas/MentorshipCreditsDetail' next_session: $ref: '#/components/schemas/MentorshipSession' open_goals: type: integer open_tasks: 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 MentorshipCreditsDetail: type: object required: - unlimited - remaining - sources - grants properties: unlimited: type: boolean remaining: type: integer next_reset_at: type: string format: date-time sources: description: As matrículas ativas que abrem a mentoria. type: array items: $ref: '#/components/schemas/MentorshipCreditSourceBalance' grants: type: array items: $ref: '#/components/schemas/MentorshipCreditGrant' MentorshipSession: type: object required: - id - mentorship_id - mentorship_name - format - status - capacity - attendees_count - consumes_credit - starts_at - ends_at - meeting - record - created_at properties: id: type: string format: uuid mentorship_id: type: string format: uuid mentorship_name: type: string format: $ref: '#/components/schemas/MentorshipSessionFormat' title: type: string status: $ref: '#/components/schemas/MentorshipSessionStatus' capacity: type: integer attendees_count: type: integer description: Quem está inscrito e não desmarcou. consumes_credit: type: boolean starts_at: type: string format: date-time ends_at: type: string format: date-time meeting: $ref: '#/components/schemas/MentorshipMeeting' meeting_url: type: string description: >- Só quando `meeting` é `link`. O da sessão, ou o do perfil de quem conduz. record: type: boolean description: Grava o encontro na sala nossa; a gravação vira arquivo da sessão. summary: type: string description: O que ficou para quem participou, em markdown. mentor_user_id: type: string format: uuid mentor_name: type: string cancelled_at: type: string format: date-time cancel_reason: type: string created_at: type: string format: date-time MentorshipCreditSourceBalance: type: object required: - enrollment_id - delivery_id - delivery_name - quota_kind - starts_at properties: enrollment_id: type: string format: uuid delivery_id: type: string format: uuid delivery_name: type: string quota_kind: $ref: '#/components/schemas/MentorshipQuotaKind' quota: type: integer remaining: type: integer description: Ausente na ilimitada. starts_at: type: string format: date-time expires_at: type: string format: date-time cycle_ends_at: type: string format: date-time MentorshipCreditGrant: type: object required: - id - quantity - remaining - reason - revoked - created_at properties: id: type: string format: uuid quantity: type: integer remaining: type: integer reason: type: string granted_by_name: type: string revoked: type: boolean created_at: type: string format: date-time MentorshipSessionFormat: type: string enum: - individual - group x-enum-varnames: - SessionFormatIndividual - SessionFormatGroup MentorshipSessionStatus: type: string enum: - upcoming - in_progress - ended - cancelled x-enum-varnames: - SessionUpcoming - SessionInProgress - SessionEnded - SessionCancelled description: | Derivado do relógio, não gravado: `ended` é ter passado de `ends_at` sem cancelamento. Não há "concluir" a clicar. MentorshipMeeting: description: | Onde o encontro acontece: `room` é a sala nossa (entra-se por `join`); `link` é o endereço de fora em `meeting_url`. type: string enum: - room - link x-enum-varnames: - MeetingRoom - MeetingLink MentorshipQuotaKind: type: string enum: - total - monthly - unlimited x-enum-varnames: - QuotaTotal - QuotaMonthly - QuotaUnlimited description: | Como a cota de CADA matrícula conta. `total`: `quota` sessões durante o acesso. `monthly`: `quota` por ciclo mensal, contado do início da matrícula (quem começou dia 31 renova no último dia dos meses curtos). `unlimited`: sem teto. 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 - [Mentorias](/essentials/mentorships.md) - [Concluir tarefa](/api-reference/mentorships/classroom-task-update.md)