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

# Consultar pastas de produtos

> Devolve as pastas de produtos da empresa autenticada com a contagem de produtos de cada uma, quantos produtos estão fora de pasta e o total. A empresa tem poucas pastas, então não há paginação.



## OpenAPI

````yaml /openapi.yaml get /v1/product-folders
openapi: 3.0.3
info:
  title: Ephra API
  description: >-
    API pública da Ephra: cobranças (PIX, cartão e boleto), transações, webhooks
    e a API do vendedor sobre catálogo, checkout, vendas, reembolsos,
    financeiro, crescimento e plataforma.


    **Limite de requisições.** 1000 requisições por minuto por IP de origem.
    Toda resposta traz `x-ratelimit-limit`, `x-ratelimit-remaining` e
    `x-ratelimit-reset` (segundos até a janela zerar); ao estourar o limite a
    resposta é `429` com `retry-after`.


    **Um `429` que não é limite de requisições.** Em `POST /v1/card` e `POST
    /v1/subscriptions`, um `429` com `code: "BUYER_ATTEMPTS_EXCEEDED"` no corpo
    significa que este comprador, e só ele, está bloqueado para pagar com cartão
    depois de tentativas recusadas em excesso. Nada foi cobrado. Não pause nem
    atrase as cobranças de outros compradores por causa dele, e não repita a
    cobrança deste comprador antes de `blockedUntil` (ISO 8601 UTC, também em
    `retryAfterSeconds` e no header `retry-after`; os dois campos vêm `null`
    quando o horário não é conhecido). Pix continua disponível para o mesmo
    comprador. Diferencie os dois casos sempre pelo `code`, nunca pelo status.


    **Erros.** Toda falha responde o mesmo envelope: `{ "success": false,
    "message": "..." }`.
  version: 1.0.0
servers:
  - url: https://api.ephra.io
    description: Servidor de produção
security: []
tags:
  - name: Catálogo
    description: Produtos, ofertas, categorias e cupons — o que a empresa vende.
  - name: Checkout
    description: Checkouts, order bumps, upsells e links de pagamento.
  - name: Vendas
    description: Vendas, clientes, assinaturas e entregas já realizadas.
  - name: Reembolsos
    description: Pedidos de reembolso, contestações e o quiz de retenção.
  - name: Financeiro
    description: Saldo, saques, antecipações, taxas e extratos da empresa.
  - name: Crescimento
    description: Afiliados, coprodução, indicações, pixels e integrações de marketing.
  - name: Plataforma
    description: Conta, membros, chaves de API, webhooks e configurações gerais.
paths:
  /v1/product-folders:
    get:
      tags:
        - Catálogo
      summary: Consultar pastas de produtos
      description: >-
        Devolve as pastas de produtos da empresa autenticada com a contagem de
        produtos de cada uma, quantos produtos estão fora de pasta e o total. A
        empresa tem poucas pastas, então não há paginação.
      operationId: getProductFolders
      responses:
        '200':
          description: Pastas e contagens.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `true` em uma resposta bem-sucedida.
                  data:
                    type: object
                    properties:
                      folders:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              description: Identificador da pasta.
                            name:
                              type: string
                              description: Nome da pasta.
                            productCount:
                              type: integer
                              description: Produtos não excluídos dentro da pasta.
                          required:
                            - id
                            - name
                            - productCount
                          additionalProperties: false
                        description: Pastas da empresa, em ordem alfabética.
                      unfiledCount:
                        type: integer
                        description: Produtos fora de qualquer pasta.
                      totalProducts:
                        type: integer
                        description: Produtos não excluídos da empresa.
                    required:
                      - folders
                      - unfiledCount
                      - totalProducts
                    additionalProperties: false
                required:
                  - success
                  - data
                additionalProperties: false
                description: Pastas e contagens.
              example:
                success: true
                data:
                  folders:
                    - id: clxf0ld3r0001qz0a1b2c3d4e
                      name: Lançamentos
                      productCount: 3
                  unfiledCount: 4
                  totalProducts: 7
        '401':
          description: Token ausente, inválido, expirado ou de empresa bloqueada.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: Token ausente, inválido, expirado ou de empresa bloqueada.
              example:
                success: false
                message: Token inválido ou expirado
        '403':
          description: Pastas de produtos não estão liberadas para esta conta.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: Pastas de produtos não estão liberadas para esta conta.
              example:
                success: false
                message: Acesso negado para esta empresa.
        '422':
          description: A requisição não passou na validação de schema.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: A requisição não passou na validação de schema.
              example:
                success: false
                message: 'name: Nome é obrigatório'
        '429':
          description: >-
            Requisições demais: o limite é de 1000 requisições por minuto por IP
            de origem. Espere o número de segundos do header `retry-after` e
            repita com recuo exponencial.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  Requisições demais: o limite é de 1000 requisições por minuto
                  por IP de origem. Espere o número de segundos do header
                  `retry-after` e repita com recuo exponencial.
              example:
                success: false
                message: Muitas requisições. Tente novamente em breve.
          headers:
            retry-after:
              $ref: '#/components/headers/retry-after'
            x-ratelimit-limit:
              $ref: '#/components/headers/x-ratelimit-limit'
            x-ratelimit-remaining:
              $ref: '#/components/headers/x-ratelimit-remaining'
            x-ratelimit-reset:
              $ref: '#/components/headers/x-ratelimit-reset'
        '500':
          description: >-
            Falha interna ao processar a requisição. Repita; se persistir, abra
            chamado com o horário e a rota.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Sempre `false` em uma resposta de erro.
                  message:
                    type: string
                    description: Mensagem legível explicando a falha.
                required:
                  - success
                  - message
                additionalProperties: false
                description: >-
                  Falha interna ao processar a requisição. Repita; se persistir,
                  abra chamado com o horário e a rota.
              example:
                success: false
                message: Erro interno do servidor
      security:
        - bearerAuth: []
components:
  headers:
    retry-after:
      description: Segundos a esperar antes de repetir a requisição.
      schema:
        type: integer
    x-ratelimit-limit:
      description: Teto de requisições na janela (1000). Presente em toda resposta.
      schema:
        type: integer
    x-ratelimit-remaining:
      description: >-
        Quantas requisições ainda cabem na janela atual. Presente em toda
        resposta.
      schema:
        type: integer
    x-ratelimit-reset:
      description: Segundos até o contador da janela zerar. Presente em toda resposta.
      schema:
        type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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