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

# Consultar curso

> Retorna o curso com as turmas (a padrão primeiro), os módulos e as aulas por `position`, com rascunhos. Não traz vídeo, texto, quiz nem materiais das aulas. Curso de outra loja responde 404.

Escopo exigido: `courses:read`.



## OpenAPI

````yaml /openapi.json get /v1/courses/{id}
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/courses/{id}:
    get:
      tags:
        - Cursos
      summary: Consultar curso
      description: >-
        Retorna o curso com as turmas (a padrão primeiro), os módulos e as aulas
        por `position`, com rascunhos. Não traz vídeo, texto, quiz nem materiais
        das aulas. Curso de outra loja responde 404.


        Escopo exigido: `courses:read`.
      operationId: getCourse
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Curso detalhado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CourseDetail'
              example:
                id: clx1course0001
                object: course
                title: Formação em NR-35
                tagline: Trabalho em altura na prática
                description: null
                status: PUBLISHED
                productId: clx1product001
                coverUrl: null
                posterUrl: https://cdn.gravitypay.app/posters/nr35.png
                certificateEnabled: true
                createdAt: '2026-05-02T13:00:00.000Z'
                updatedAt: '2026-08-20T09:12:00.000Z'
                cohorts:
                  - id: clx1cohort001
                    object: cohort
                    courseId: clx1course0001
                    name: Turma padrão
                    isDefault: true
                    createdAt: '2026-05-02T13:00:00.000Z'
                  - id: clx1cohort002
                    object: cohort
                    courseId: clx1course0001
                    name: Mentoria
                    isDefault: false
                    createdAt: '2026-06-10T18:30:00.000Z'
                modules:
                  - id: clx1module001
                    object: module
                    title: Fundamentos
                    description: null
                    position: 1
                    status: PUBLISHED
                    releaseRule: ON_PURCHASE
                    visibleCohortIds: null
                    lessons:
                      - id: clx1lesson001
                        object: lesson
                        moduleId: clx1module001
                        title: Boas-vindas
                        type: VIDEO
                        position: 1
                        status: PUBLISHED
                        releaseRule: ON_PURCHASE
                        durationSeconds: 312
                  - id: clx1module002
                    object: module
                    title: Encontros da mentoria
                    description: Só para a turma Mentoria.
                    position: 2
                    status: DRAFT
                    releaseRule: AFTER_GUARANTEE
                    visibleCohortIds:
                      - clx1cohort002
                    lessons: []
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/InsufficientScope'
        '404':
          $ref: '#/components/responses/Error'
components:
  schemas:
    CourseDetail:
      allOf:
        - $ref: '#/components/schemas/Course'
        - type: object
          required:
            - cohorts
            - modules
          properties:
            cohorts:
              type: array
              description: Turma padrão primeiro, depois por createdAt crescente.
              items:
                $ref: '#/components/schemas/Cohort'
            modules:
              type: array
              description: Por position crescente, com rascunhos.
              items:
                $ref: '#/components/schemas/Module'
    Course:
      type: object
      required:
        - id
        - object
        - title
        - tagline
        - description
        - status
        - productId
        - coverUrl
        - posterUrl
        - certificateEnabled
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
        object:
          type: string
          enum:
            - course
        title:
          type: string
        tagline:
          type:
            - string
            - 'null'
        description:
          type:
            - string
            - 'null'
        status:
          type: string
          enum:
            - DRAFT
            - PUBLISHED
        productId:
          type: string
          description: Um curso por produto.
        coverUrl:
          type:
            - string
            - 'null'
        posterUrl:
          type:
            - string
            - 'null'
        certificateEnabled:
          type: boolean
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    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
    Module:
      type: object
      required:
        - id
        - object
        - title
        - description
        - position
        - status
        - releaseRule
        - visibleCohortIds
        - lessons
      properties:
        id:
          type: string
        object:
          type: string
          enum:
            - module
        title:
          type: string
        description:
          type:
            - string
            - 'null'
        position:
          type: integer
        status:
          type: string
          enum:
            - DRAFT
            - PUBLISHED
        releaseRule:
          type: string
          enum:
            - ON_PURCHASE
            - AFTER_GUARANTEE
        visibleCohortIds:
          type:
            - array
            - 'null'
          items:
            type: string
          description: Turmas que veem o módulo. null = todas as turmas.
        lessons:
          type: array
          description: Por position crescente, com rascunhos.
          items:
            $ref: '#/components/schemas/Lesson'
    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`.
    Lesson:
      type: object
      description: >-
        Estrutura da aula. Não traz vídeo, texto, quiz, materiais nem
        transcrição.
      required:
        - id
        - object
        - moduleId
        - title
        - type
        - position
        - status
        - releaseRule
        - durationSeconds
      properties:
        id:
          type: string
        object:
          type: string
          enum:
            - lesson
        moduleId:
          type: string
        title:
          type: string
        type:
          type: string
          enum:
            - VIDEO
            - TEXT
            - QUIZ
        position:
          type: integer
        status:
          type: string
          enum:
            - DRAFT
            - PUBLISHED
        releaseRule:
          type: string
          enum:
            - ON_PURCHASE
            - AFTER_GUARANTEE
        durationSeconds:
          type:
            - integer
            - 'null'
          description: Duração do vídeo. null em texto, quiz e vídeo sem duração medida.
  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

````