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

# Listar turmas

> Lista paginada das turmas dos cursos da loja da chave. Ordem: `createdAt` crescente e, no empate, `id` crescente. Um `courseId` que não é da loja responde 400 com `param` `courseId`.

Escopo exigido: `courses:read`.



## OpenAPI

````yaml /openapi.json get /v1/cohorts
openapi: 3.1.0
info:
  title: Gravity Play API
  version: 1.0.0
  description: >-
    API para criar cobranças, receber pagamentos e ler cursos, turmas, alunos e
    progresso da área de membros. Cada chave de API tem escopos; cada operação
    indica o escopo que exige.
servers:
  - url: https://api.sandbox.gravitypay.app
    description: Sandbox (testes) — alvo do try-it
  - url: https://api.gravitypay.app
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Cobranças
    description: Cobranças avulsas com link de pagamento.
  - name: Pagamentos
    description: Vendas da loja e vendedores.
  - name: Assinaturas
    description: Assinaturas da loja, com dados do cliente. Exige `subscriptions:read`.
  - name: Cursos
    description: Cursos da área de membros, com módulos e aulas.
  - name: Turmas
    description: Turmas dos cursos.
  - name: Alunos
    description: 'Alunos, matrículas e progresso. Dado pessoal: exige `students:read`.'
paths:
  /v1/cohorts:
    get:
      tags:
        - Turmas
      summary: Listar turmas
      description: >-
        Lista paginada das turmas dos cursos da loja da chave. Ordem:
        `createdAt` crescente e, no empate, `id` crescente. Um `courseId` que
        não é da loja responde 400 com `param` `courseId`.


        Escopo exigido: `courses:read`.
      operationId: listCohorts
      parameters:
        - $ref: '#/components/parameters/Page'
        - $ref: '#/components/parameters/PerPage'
        - name: courseId
          in: query
          required: false
          schema:
            type: string
          description: Devolve só as turmas deste curso.
      responses:
        '200':
          description: Lista de turmas
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CohortList'
              example:
                object: list
                data:
                  - id: clx1cohort001
                    object: cohort
                    courseId: clx1course0001
                    name: Turma padrão
                    isDefault: true
                    createdAt: '2026-05-02T13:00:00.000Z'
                page: 1
                perPage: 50
                total: 1
                totalPages: 1
                hasMore: false
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/InsufficientScope'
components:
  parameters:
    Page:
      name: page
      in: query
      required: false
      schema:
        type: integer
        minimum: 1
        default: 1
      description: >-
        Página (começa em 1). Página além da última devolve `data` vazio e
        `hasMore` false.
    PerPage:
      name: perPage
      in: query
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 50
      description: Itens por página (1 a 100; default 50).
  schemas:
    CohortList:
      type: object
      required:
        - object
        - data
        - page
        - perPage
        - total
        - totalPages
        - hasMore
      properties:
        object:
          type: string
          enum:
            - list
        data:
          type: array
          items:
            $ref: '#/components/schemas/Cohort'
        page:
          type: integer
        perPage:
          type: integer
        total:
          type: integer
        totalPages:
          type: integer
        hasMore:
          type: boolean
    Cohort:
      type: object
      required:
        - id
        - object
        - courseId
        - name
        - isDefault
        - createdAt
      properties:
        id:
          type: string
        object:
          type: string
          enum:
            - cohort
        courseId:
          type: string
        name:
          type: string
        isDefault:
          type: boolean
        createdAt:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        error:
          type: object
          required:
            - type
            - message
          properties:
            type:
              type: string
              description: >-
                `authentication` (401), `insufficient_scope` (403),
                `invalid_request` (400) ou `not_found` (404).
            message:
              type: string
            param:
              type: string
              description: Parâmetro que falhou, em `invalid_request`.
            requiredScope:
              type: string
              description: Escopo que falta, em `insufficient_scope`.
  responses:
    Error:
      description: Erro
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InsufficientScope:
      description: A chave é válida, mas não tem o escopo exigido pela operação.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: insufficient_scope
              message: Esta chave de API não tem o escopo students:read.
              requiredScope: students:read
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````