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

# Busca cursos, módulos e aulas

> Busca cursos, módulos e aulas.

Mesma busca da área de membros hospedada. Os resultados de aulas incluem trechos das legendas dos vídeos em `captions`, com o segundo em que cada trecho aparece: abra a aula com `t` igual a esse segundo para ir direto ao trecho.


## OpenAPI

````yaml headless/openapi.yml GET /api/headless/v1/search
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/search:
    get:
      tags:
        - search
      summary: Busca cursos, módulos e aulas
      description: Busca cursos, módulos e aulas.
      operationId: search
      parameters:
        - name: q
          in: query
          required: false
          schema:
            type: string
          description: Termo de busca.
        - name: type
          in: query
          required: false
          description: >-
            Tipo de resultado; bookmark traz só as aulas salvas pelo membro, que
            voltam com type lesson. Omitido, busca em tudo.
          schema:
            type: string
            enum:
              - course
              - section
              - lesson
              - bookmark
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Page'
      responses:
        '200':
          description: Resultados
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResponse'
        '400':
          $ref: '#/components/responses/MalformedRequest'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '402':
          $ref: '#/components/responses/SubscriptionSuspended'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  parameters:
    Limit:
      name: limit
      in: query
      required: false
      description: Quantidade de itens por página, de 1 a 100.
      schema:
        type: integer
        default: 20
    Page:
      name: page
      in: query
      required: false
      description: Número da página, a partir de 1.
      schema:
        type: integer
        default: 1
  schemas:
    SearchResponse:
      allOf:
        - $ref: '#/components/schemas/List'
        - type: object
          required:
            - data
            - counts
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/SearchResult'
            counts:
              type: object
              description: >-
                Total de resultados de cada tipo, com as mesmas chaves do
                parâmetro type.
              required:
                - course
                - section
                - lesson
                - bookmark
              properties:
                course:
                  type: integer
                section:
                  type: integer
                lesson:
                  type: integer
                bookmark:
                  type: integer
    List:
      type: object
      description: Formato de todas as listas, com os itens em data.
      required:
        - page
        - total_pages
      properties:
        page:
          type: integer
          description: Página atual.
        total_pages:
          type: integer
          description: Total de páginas; 1 numa lista vazia.
    SearchResult:
      type: object
      required:
        - type
        - id
        - title
        - course
        - description
        - captions
        - image_url
        - duration
        - comments_count
      properties:
        type:
          type: string
          enum:
            - course
            - section
            - lesson
        id:
          type: integer
        title:
          type: string
        course:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/NamedRef'
        description:
          type:
            - string
            - 'null'
        image_url:
          type:
            - string
            - 'null'
        duration:
          type:
            - integer
            - 'null'
        comments_count:
          type:
            - integer
            - 'null'
        captions:
          type: array
          description: >-
            Trechos das legendas do vídeo; abra a aula com t=start_time para ir
            ao trecho.
          items:
            type: object
            required:
              - start_time
              - text
            properties:
              start_time:
                type: integer
              text:
                type: string
    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.
    NamedRef:
      type: object
      required:
        - id
        - name
      properties:
        id:
          type: integer
        name:
          type: string
  responses:
    MalformedRequest:
      description: Requisição malformada (code malformed_request).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    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'
    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.