> ## 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.

# Sessões do mentorado

> A agenda e o histórico de uma pessoa.



## OpenAPI

````yaml GET /v1/clubs/{clubId}/mentorships/{mentorshipId}/participants/{studentId}/sessions
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}/sessions:
    parameters:
      - $ref: '#/components/parameters/OrgId'
      - $ref: '#/components/parameters/MentorshipId'
      - $ref: '#/components/parameters/StudentId'
    get:
      tags:
        - mentorships
      summary: As sessões do mentorado
      operationId: listMentorshipParticipantSessions
      parameters:
        - name: upcoming
          in: query
          description: |
            `true` traz as que ainda não terminaram, da mais próxima para a
            mais distante; `false`, as que já terminaram. Ausente traz tudo.
          schema:
            type: boolean
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
        - name: page
          in: query
          schema:
            type: integer
            minimum: 1
            default: 1
      responses:
        '200':
          description: As sessões
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MentorshipSessionList'
        '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:
    MentorshipSessionList:
      type: object
      required:
        - data
        - total
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/MentorshipSession'
        total:
          type: integer
    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
    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
    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
  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

- [Arquivos do mentorado](/api-reference/mentorships/participant-files-list.md)
- [Plano do mentorado](/api-reference/mentorships/plan-get.md)
- [Definir arquivos do mentorado](/api-reference/mentorships/participant-files-set.md)
- [Minhas sessões](/api-reference/mentorships/classroom-sessions-list.md)
- [Conceder sessões avulsas](/api-reference/mentorships/credit-grant-create.md)
