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

# Lista as categorias da vitrine

> Retorna as categorias da vitrine.

Traz as categorias com cursos que o membro pode ver, na ordem definida no painel: cada subcategoria logo depois da categoria principal, e as categorias fixadas por último. Use `parent_id` para aninhar as subcategorias.

Donos e administradores veem todas. `courses_count` conta os cursos da própria categoria, sem as subcategorias.


## OpenAPI

````yaml headless/openapi.yml GET /api/headless/v1/categories
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/categories:
    get:
      tags:
        - categories
      summary: Lista as categorias da vitrine
      description: Retorna as categorias da vitrine.
      operationId: listCategories
      responses:
        '200':
          description: Categorias
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/List'
                  - type: object
                    required:
                      - data
                    properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/Category'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '402':
          $ref: '#/components/responses/SubscriptionSuspended'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    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.
    Category:
      type: object
      required:
        - id
        - name
        - parent_id
        - courses_count
        - pinned
        - horizontal_scrolling
        - vertical_covers
      properties:
        id:
          type: integer
        name:
          type: string
        parent_id:
          type:
            - integer
            - 'null'
        courses_count:
          type: integer
          description: Cursos publicados na categoria, sem contar as subcategorias.
        pinned:
          type: boolean
          description: >-
            Categoria fixada, que a área de membros hospedada mostra como atalho
            no topo da vitrine.
        horizontal_scrolling:
          type: boolean
          description: >-
            O produtor pediu que a categoria seja uma linha com rolagem
            horizontal.
        vertical_covers:
          type: boolean
          description: O produtor pediu capas verticais para os cursos da categoria.
    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.
  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'
    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.