> ## Documentation Index
> Fetch the complete documentation index at: https://ajuda.memberkit.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Retorna o curso com módulos e aulas

> Retorna um curso específico com seus módulos e aulas.

Traz os módulos e as aulas que o membro pode ver, já filtrados pelas regras de liberação da turma. Módulos e aulas ocultos não aparecem.

Uma aula que ainda não pode ser aberta vem com `lock` preenchido, explicando o motivo; veja [Retorna uma aula](https://ajuda.memberkit.com.br/headless/referencia/get-lesson.md#aulas-bloqueadas). Mostre-a com o motivo em vez de escondê-la.

* `hero_image_url` é a imagem de destaque do curso, com até 2400x1350. Quando ela não foi enviada, use `image_url`.
* A `image_url` de cada módulo é a capa vertical, recortada em 300x420, ou nula.
* A `image_url` de cada aula é a miniatura enviada para ela ou, sem miniatura, a capa do vídeo. Vem nula quando a aula não tem nenhuma das duas.
* Cada módulo traz `description`, para mostrar abaixo do nome, e `collapsed`, quando o produtor pediu que ele comece recolhido na lista de aulas.
* `preferred_layout` é `list` para mostrar as aulas numa lista única, ou `grid` para mostrar os módulos como cartões.

O parâmetro opcional `classroom` escolhe a turma quando o membro pode ver várias, como moderadores e assistentes. Sem ele, vale a turma do acesso do membro.


## OpenAPI

````yaml headless/openapi.yml GET /api/headless/v1/courses/{id}
openapi: 3.1.0
info:
  title: MemberKit Headless
  version: 1.0.0
servers: []
security:
  - bearer: []
    headlessKey: []
tags:
  - name: academy
  - name: auth
  - name: onboarding
  - name: courses
  - name: categories
  - name: banners
  - name: bookmarks
  - name: kv
  - name: comments
  - name: quizzes
  - name: search
  - name: ranking
  - name: profile
  - name: certificates
  - name: contact_messages
  - name: notifications
  - name: uploads
  - name: assistant
  - name: community
  - name: lessons
paths:
  /api/headless/v1/courses/{id}:
    get:
      tags:
        - courses
      summary: Retorna o curso com módulos e aulas
      description: Retorna um curso específico com seus módulos e aulas.
      operationId: getCourse
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: ID do curso.
        - name: classroom
          in: query
          required: false
          description: ID da turma.
          schema:
            type: integer
      responses:
        '200':
          description: Curso encontrado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CourseDetails'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '402':
          $ref: '#/components/responses/SubscriptionSuspended'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: Curso fora dos cursos que o membro pode abrir
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    CourseDetails:
      allOf:
        - $ref: '#/components/schemas/Course'
        - type: object
          required:
            - hero_image_url
            - access_expires_at
            - classroom
            - sections
          properties:
            hero_image_url:
              type:
                - string
                - 'null'
              description: URL da imagem de destaque do curso.
            access_expires_at:
              type:
                - string
                - 'null'
              format: date-time
              description: >-
                Quando termina o acesso do membro ao curso; nulo quando não
                expira.
            classroom:
              type: object
              required:
                - id
                - name
              properties:
                id:
                  type: integer
                name:
                  type: string
            sections:
              type: array
              items:
                type: object
                required:
                  - id
                  - name
                  - description
                  - collapsed
                  - image_url
                  - lessons
                properties:
                  id:
                    type: integer
                  name:
                    type: string
                  description:
                    type:
                      - string
                      - 'null'
                  collapsed:
                    type: boolean
                    description: >-
                      O produtor pediu que o módulo comece recolhido na lista de
                      aulas.
                  image_url:
                    type:
                      - string
                      - 'null'
                    description: Capa vertical do módulo.
                  lessons:
                    type: array
                    items:
                      $ref: '#/components/schemas/LessonSummary'
    Error:
      type: object
      description: Formato de todos os erros.
      required:
        - code
        - message
        - request_id
      properties:
        code:
          type: string
          description: Código do erro.
          enum:
            - subscription_suspended
            - onboarding_required
            - course_onboarding_required
            - access_expired
            - content_locked
            - comments_disabled
            - unprocessable_certificate
            - unauthenticated
            - invalid_credentials
            - invalid_token
            - invalid_headless_key
            - session_replaced
            - session_revoked
            - account_locked
            - forbidden
            - not_found
            - missing_parameter
            - malformed_request
            - validation_failed
            - invalid_signed_id
            - rate_limited
            - idempotency_key_reused
            - request_in_progress
            - assistant_unavailable
            - quiz_required
        message:
          type: string
        request_id:
          type: string
        errors:
          type: object
          description: Erros de cada campo, presentes com o código validation_failed.
          additionalProperties:
            type: array
            items:
              type: object
              required:
                - code
                - message
              properties:
                code:
                  type: string
                  description: Motivo do erro, como blank, taken, too_short ou invalid.
                message:
                  type: string
                  description: Mensagem pronta para exibir, no idioma da área de membros.
    Course:
      type: object
      required:
        - id
        - slug
        - name
        - description
        - preferred_layout
        - lessons_count
        - image_url
        - poster_url
        - category
        - enrolled
        - progress
        - checkout_url
      properties:
        id:
          type: integer
        slug:
          type: string
        name:
          type: string
        description:
          type: string
        preferred_layout:
          type: string
          enum:
            - list
            - grid
          description: Layout do curso, em lista ou em cartões.
        lessons_count:
          type: integer
        image_url:
          type:
            - string
            - 'null'
          description: Capa horizontal 432x216.
        poster_url:
          type:
            - string
            - 'null'
          description: Capa vertical 300x420, para categorias com capas verticais.
        category:
          type:
            - object
            - 'null'
          required:
            - id
            - name
          properties:
            id:
              type: integer
            name:
              type: string
        enrolled:
          type: boolean
          description: Se o membro pode abrir o curso.
        progress:
          type: integer
          minimum: 0
          maximum: 100
        checkout_url:
          type:
            - string
            - 'null'
          description: Página de vendas do curso, presente apenas quando enrolled é falso.
    LessonSummary:
      type: object
      required:
        - id
        - title
        - duration
        - completed
        - image_url
        - lock
      properties:
        id:
          type: integer
        title:
          type: string
        duration:
          type: integer
          description: Duração do vídeo em segundos; zero sem vídeo.
        completed:
          type: boolean
        image_url:
          type:
            - string
            - 'null'
          description: Miniatura da aula ou, sem ela, a capa do vídeo.
        lock:
          description: Nulo quando a aula pode ser aberta.
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/LessonLock'
    LessonLock:
      type: object
      required:
        - reason
        - available_at
        - requirement
      properties:
        reason:
          type: string
          enum:
            - blocked
            - deadline_passed
            - countdown
            - timespan
            - after_section
            - after_course
            - after_lesson
            - minimum_scoring
            - course_onboarding
          description: Motivo do bloqueio.
        available_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Data de liberação, presente para countdown e timespan.
        requirement:
          type:
            - string
            - 'null'
          description: >-
            O título da aula, o nome do módulo ou do curso a concluir, ou os
            pontos que faltam.
  responses:
    Unauthenticated:
      description: >-
        Membro não autenticado (code unauthenticated, invalid_token,
        session_replaced, session_revoked ou invalid_headless_key).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    SubscriptionSuspended:
      description: Assinatura da área de membros suspensa (code subscription_suspended).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: >-
        Acesso negado (code forbidden, onboarding_required,
        course_onboarding_required, access_expired, content_locked,
        comments_disabled, quiz_required ou assistant_unavailable).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: Limite de requisições atingido (code rate_limited).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
    headlessKey:
      type: apiKey
      in: header
      name: X-Memberkit-Headless-Key
      description: >-
        Chave headless da área de membros, em Configurações. É pública e vai em
        todas as requisições, inclusive nas que levam o token do membro.

````

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