> ## 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. # Quem mentora > Com as mentorias que cada pessoa atende. ## OpenAPI ````yaml GET /v1/clubs/{clubId}/mentors 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}/mentors: parameters: - $ref: '#/components/parameters/OrgId' get: tags: - mentorships summary: Quem mentora no club description: Com as mentorias que cada pessoa atende. Qualquer pessoa do club lê. operationId: listMentors responses: '200': description: Os mentores content: application/json: schema: $ref: '#/components/schemas/MentorProfileList' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '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: MentorProfileList: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/MentorProfile' MentorProfile: type: object required: - user_id - name - email - role - meeting - timezone - mentorships properties: user_id: type: string format: uuid name: type: string email: type: string format: email role: $ref: '#/components/schemas/MembershipRole' bio: type: string meeting: $ref: '#/components/schemas/MentorshipMeeting' meeting_url: type: string description: >- O endereço da sala de fora, quando `meeting` é `link` e a sessão não traz um próprio. timezone: type: string description: O fuso IANA em que a semana da pessoa é lida. mentorships: description: As mentorias que a pessoa atende. type: array items: $ref: '#/components/schemas/MentorshipRef' 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 MembershipRole: type: string enum: - owner - admin - member description: | O papel decide o que a pessoa pode fazer no club. `owner` criou o club; `admin` administra junto (catálogo, conteúdo, endereço, time); `member` pertence sem administrar — lê, e nada mais. 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 MentorshipRef: type: object required: - id - name properties: id: type: string format: uuid name: type: string 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' 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) - [Editar meta](/api-reference/mentorships/goal-update.md) - [Concluir tarefa](/api-reference/mentorships/classroom-task-update.md) - [Metas e tarefas do aluno](/api-reference/mentorships/classroom-plan.md) - [Limites de uso](/essentials/rate-limits.md)