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

# Comunidade do aluno

> Os espaços que a pessoa enxerga, com a vitrine dos privados.



## OpenAPI

````yaml GET /v1/clubs/{clubId}/classroom/community
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}/classroom/community:
    parameters:
      - $ref: '#/components/parameters/OrgId'
    get:
      tags:
        - community
      summary: A comunidade do club, como o aluno a vê
      description: |
        O nome e os espaços que quem está na sessão enxerga, na ordem.

        Espaço `community` aparece para quem tem a comunidade. Espaço privado
        aparece para quem tem a entrega DELE — e, com visibilidade `members`,
        também para o resto da comunidade, trancado (`has_access: false`), como
        vitrine: nome e descrição, e nada do que se fala lá dentro.

        Comunidade inexistente ou ainda não publicada responde 404; quem não
        alcança espaço nenhum recebe 403 `not_entitled`.
      operationId: getClassroomCommunity
      responses:
        '200':
          description: A comunidade
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClassroomCommunityResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - studentSession: []
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:
    ClassroomCommunityResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/ClassroomCommunity'
    ClassroomCommunity:
      type: object
      required:
        - name
        - spaces
      properties:
        name:
          type: string
        description:
          type: string
        spaces:
          type: array
          items:
            $ref: '#/components/schemas/ClassroomCommunitySpace'
    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
    ClassroomCommunitySpace:
      type: object
      required:
        - id
        - name
        - posting
        - private
        - has_access
        - can_post
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        description:
          type: string
        posting:
          $ref: '#/components/schemas/CommunitySpacePosting'
        private:
          type: boolean
          description: O espaço é privado — abre com uma entrega própria.
        has_access:
          type: boolean
          description: |
            Falso é a vitrine de um espaço privado: a tela desenha o cadeado, e
            ler o feed dele responde 403.
        can_post:
          type: boolean
    CommunitySpacePosting:
      type: string
      enum:
        - members
        - staff
      x-enum-varnames:
        - SpacePostingMembers
        - SpacePostingStaff
      description: |
        Quem publica. `staff` é o espaço de avisos: o aluno lê, comenta e reage.
  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:
    studentSession:
      type: http
      scheme: bearer
      description: |
        Token OPACO de sessão de aluno, emitido por `/v1/auth/sign-in` e
        verificado contra a nossa tabela — não é JWT e não se lê nada dele.

        A ida ao banco não é custo novo: toda requisição autenticada já resolve
        o dono da sessão. Em troca, encerrar uma sessão vale no mesmo instante,
        sem lista de bloqueio nem janela de tolerância.

        O classroom o guarda em cookie **host-only**: um cookie de domínio o
        mandaria para os subdomínios dos outros clubs.

````

## Related topics

- [Comunidade do club](/api-reference/community/managed-get.md)
- [Sessão do aluno](/api-reference/auth/session.md)
- [Cursos do aluno](/api-reference/classroom/courses-list.md)
- [Turmas do aluno](/api-reference/classroom/cohorts-list.md)
