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

# Aulas do club

> As aulas de todos os cursos, com o curso e o módulo pelo nome.



## OpenAPI

````yaml GET /v1/clubs/{clubId}/lessons
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}/lessons:
    parameters:
      - $ref: '#/components/parameters/OrgId'
    get:
      tags:
        - content
      summary: Aulas do club
      description: |
        As aulas de todos os cursos, na mesma forma da lista de cursos: filtra,
        ordena e pagina no servidor. Cada aula vem com o curso e o módulo pelo
        nome, que é o que a linha escreve.

        A pergunta aqui é "o que foi escrito neste club", e não "o que tem
        neste curso" — essa continua sendo a estrutura em
        `GET /v1/clubs/{clubId}/courses/{courseId}`.

        Qualquer membro lê.
      operationId: listLessons
      parameters:
        - name: q
          in: query
          description: Busca no título da aula.
          schema:
            type: string
            maxLength: 200
        - name: status
          in: query
          description: |
            Um ou vários. Ausente traz o que está de pé, como na lista de
            cursos. É o estado da PRÓPRIA aula: uma aula publicada dentro de um
            curso arquivado continua `published` aqui, e é o curso que está
            fora de vista.
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ContentStatus'
        - name: course_id
          in: query
          description: Só as aulas deste curso.
          schema:
            type: string
            format: uuid
        - name: created_from
          in: query
          schema:
            type: string
            format: date-time
        - name: created_until
          in: query
          schema:
            type: string
            format: date-time
        - name: sort
          in: query
          schema:
            type: string
            enum:
              - created
              - title
            default: created
        - name: order
          in: query
          schema:
            type: string
            enum:
              - asc
              - desc
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
        - name: page
          in: query
          schema:
            type: integer
            minimum: 1
            default: 1
      responses:
        '200':
          description: As aulas do recorte pedido
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LessonSummaryList'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '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:
    ContentStatus:
      type: string
      enum:
        - published
        - draft
        - archived
      description: |
        O estado de um curso ou de uma aula, e os três são excludentes:
        `archived` é o que foi tirado de vista, `draft` é o que nunca foi
        publicado (ou está agendado para o futuro) e `published` é o que já
        vale para quem tem acesso. Não é uma coluna: sai de `archived` e de
        `published_at`, que continuam sendo a verdade.
    LessonSummaryList:
      type: object
      required:
        - data
        - total
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/LessonSummary'
        total:
          type: integer
    LessonSummary:
      description: |
        A aula fora do curso dela — o que a listagem de conteúdo mostra.

        Não é o `Lesson`: sem o corpo, sem a mídia e sem os anexos, que seriam
        uma consulta por aula para desenhar uma linha de texto. O curso e o
        módulo vêm pelo nome porque a linha os escreve.
      type: object
      required:
        - id
        - title
        - public_id
        - type
        - position
        - archived
        - course_id
        - course_title
        - module_id
        - module_title
        - module_position
        - created_at
      properties:
        id:
          type: string
          format: uuid
        title:
          type: string
        public_id:
          type: string
          description: A chave da URL do classroom.
        type:
          $ref: '#/components/schemas/LessonType'
        duration_seconds:
          type: integer
        position:
          type: integer
        archived:
          type: boolean
        published_at:
          type: string
          format: date-time
          description: Ausente é rascunho; no futuro é agendado.
        course_id:
          type: string
          format: uuid
        course_title:
          type: string
        module_id:
          type: string
          format: uuid
        module_title:
          type: string
        module_position:
          type: integer
          description: Onde o módulo está no curso — é o "Módulo 3" da linha.
        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
    LessonType:
      type: string
      enum:
        - video
        - text
        - audio
        - file
  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'
    UnprocessableEntity:
      description: Campos obrigatórios ausentes ou inválidos
      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

- [Caixa de comentários do club](/api-reference/comments/managed-list.md)
- [Configurações do club](/api-reference/clubs/settings-get.md)
- [Assistir aula](/api-reference/classroom/lessons-get.md)
- [Criar aula](/api-reference/content/lessons-create.md)
- [Alterar aula](/api-reference/content/lessons-update.md)
