> ## Documentation Index
> Fetch the complete documentation index at: https://docs.followw.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Consultar as turmas do usuário autenticado

> Cada turma traz a menção do usuário em grade (null até ser lançada ou sincronizada). A menção é atualizada pelo sync do login e de /auth/sigaa/refresh.



## OpenAPI

````yaml /mintlify/openapi.json get /classrooms
openapi: 3.1.0
info:
  title: Followw UnB API
  description: >-
    Cliente alternativo e open-source para o ecossistema de sistemas da
    Universidade de Brasília (UnB). Agrega em uma experiência unificada e
    performática dados do SIGAA, Restaurante Universitário (RU) e calendário
    oficial, com autenticação stateless delegada ao CAS da UnB, credenciais
    cifradas em cookies JWE (AES-256-GCM), sincronização assíncrona inteligente
    e cache resiliente via Stale-While-Revalidate.
  version: 0.1.0
servers:
  - url: https://api.followw.app
    description: Produção
  - url: http://localhost:8000
    description: Desenvolvimento local
security: []
tags:
  - name: Auth
    description: >-
      Autenticação via SIGAA/CAS da UnB e gerenciamento de sessão stateless por
      cookies.
  - name: Classrooms
    description: >-
      Turmas do semestre e histórico, participantes, frequência e estatísticas
      de aprovação.
  - name: Me
    description: >-
      Perfil acadêmico, extrato/saldo do RU e carteirinha do estudante
      autenticado.
  - name: Public Classrooms
    description: Busca pública de turmas e unidades do SIGAA, sem autenticação.
    x-displayName: Classrooms
  - name: Public Courses
    description: >-
      Cursos cadastrados e seus currículos por semestre de ingresso, sem
      autenticação.
    x-displayName: Courses
  - name: Public Professors
    description: Catálogo público de docentes do SIGAA, sem autenticação.
    x-displayName: Professors
  - name: Public Restaurant
    description: Cardápio público do RU, sem autenticação.
    x-displayName: Restaurant
  - name: Public Subjects
    description: Componentes curriculares de graduação e suas turmas, sem autenticação.
    x-displayName: Subjects
  - name: Posts
    description: >-
      Notícias e avaliações recentes das turmas, consultadas diretamente na home
      do SIGAA.
paths:
  /classrooms:
    get:
      tags:
        - Classrooms
      summary: Consultar as turmas do usuário autenticado
      description: >-
        Cada turma traz a menção do usuário em grade (null até ser lançada ou
        sincronizada). A menção é atualizada pelo sync do login e de
        /auth/sigaa/refresh.
      operationId: get_classrooms_classrooms_get
      parameters:
        - name: semester
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                pattern: ^(all|[0-9]{4}\.[0-9])$
              - type: 'null'
            description: >-
              Sem filtro: turmas atuais. Use 'all' ou um semestre no formato
              AAAA.P, como 2026.2.
            title: Semester
          description: >-
            Sem filtro: turmas atuais. Use 'all' ou um semestre no formato
            AAAA.P, como 2026.2.
        - name: Cache-Control
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              `no-cache` (ou `max-age=0`) busca na origem antes de responder;
              `max-age=N` aceita cache de até N s; `stale-if-error[=N]` devolve
              o cache se a origem falhar; `only-if-cached` nunca busca (504 sem
              cache).
            title: Cache-Control
          description: >-
            `no-cache` (ou `max-age=0`) busca na origem antes de responder;
            `max-age=N` aceita cache de até N s; `stale-if-error[=N]` devolve o
            cache se a origem falhar; `only-if-cached` nunca busca (504 sem
            cache).
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ParticipantClassroom'
                title: Response Get Classrooms Classrooms Get
        '401':
          description: Credenciais ausentes ou inválidas.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '502':
          description: SIGAA indisponível.
components:
  schemas:
    ParticipantClassroom:
      properties:
        professors:
          items:
            type: string
          type: array
          title: Professors
          default: []
        vacancies:
          anyOf:
            - type: integer
            - type: 'null'
          title: Vacancies
          description: Vagas na coleta do seed, não em tempo real.
        occupied:
          anyOf:
            - type: integer
            - type: 'null'
          title: Occupied
          description: Ocupação na coleta do seed, não em tempo real.
        id:
          type: string
          title: Id
        sigaa_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Sigaa Id
        number:
          type: string
          title: Number
        semester:
          type: string
          title: Semester
        schedule:
          anyOf:
            - type: string
            - type: 'null'
          title: Schedule
        room:
          anyOf:
            - type: string
            - type: 'null'
          title: Room
        current:
          type: boolean
          title: Current
          default: false
        subject:
          $ref: '#/components/schemas/UserSubject'
        grade:
          anyOf:
            - $ref: '#/components/schemas/Grade'
            - type: 'null'
        status:
          anyOf:
            - $ref: '#/components/schemas/ClassroomStatus'
            - type: 'null'
      type: object
      required:
        - id
        - number
        - semester
        - subject
      title: ParticipantClassroom
      description: >-
        A turma com a menção do usuário, `None` enquanto não lançada ou
        sincronizada.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    UserSubject:
      properties:
        code:
          type: string
          title: Code
        name:
          type: string
          title: Name
        hours:
          anyOf:
            - type: integer
            - type: 'null'
          title: Hours
        unit:
          anyOf:
            - $ref: '#/components/schemas/UnitRef'
            - type: 'null'
      type: object
      required:
        - code
        - name
      title: UserSubject
      description: O componente como o cache guarda, pelo código.
    Grade:
      type: string
      enum:
        - SS
        - MS
        - MM
        - MI
        - II
        - SR
      title: Grade
    ClassroomStatus:
      type: string
      enum:
        - cursando
        - trancado
        - concluido
        - pending_enrollment
        - denied
      title: ClassroomStatus
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    UnitRef:
      properties:
        id:
          type: integer
          title: Id
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
        name:
          type: string
          title: Name
      type: object
      required:
        - id
        - code
        - name
      title: UnitRef
      description: 'Unidade acadêmica: `id` do SIGAA, `code` a sigla (ex.: FCTE).'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.