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

# Listar produtos

> Retorna uma lista paginada de produtos da conta.



## OpenAPI

````yaml /api-reference/openapi.yml get /api/v1/products
openapi: 3.1.0
info:
  title: API - Simplo
  version: 1.0.0
  description: API para cobrança e assinaturas para contas Simplo
  contact:
    name: Simplo
    url: https://besimplo.com
    email: team@besimplo.com
servers:
  - url: https://besimplo.com
    description: Produção
security:
  - apiKeyAuth: []
tags:
  - name: Clientes
    description: Clientes são as pessoas que pagarão pelos produtos da sua conta
  - name: Produtos
    description: Produtos representam os bens ou serviços que você vende
  - name: Preços
    description: Preços definem quanto cobrar e a frequência de cobrança de um Produto
  - name: Assinaturas
    description: Assinaturas conectam clientes aos seus planos para cobrança recorrente
  - name: Checkout
    description: >-
      Sessões de checkout permitem que clientes completem pagamentos e
      assinaturas através de uma interface web
  - name: Faturas
    description: Faturas representam cobranças geradas para clientes
  - name: Reembolsos
    description: Reembolsos permitem devolver pagamentos já realizados aos clientes
  - name: Webhooks
    description: >
      Eventos enviados via HTTP POST para a URL configurada na sua conta.
      Responda com status 2xx rapidamente. Processe o evento de forma
      assincrona. Use o campo `event.id` para garantir idempotencia.
paths:
  /api/v1/products:
    get:
      tags:
        - Produtos
      summary: Listar produtos
      description: Retorna uma lista paginada de produtos da conta.
      operationId: listProducts
      parameters:
        - name: active
          in: query
          description: Filtrar por status ativo/inativo
          schema:
            type: boolean
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
          description: Resultados por página
        - name: page
          in: query
          schema:
            type: string
          description: Cursor para próxima página
      responses:
        '200':
          description: Lista de produtos
          content:
            application/json:
              schema:
                type: object
                unevaluatedProperties: false
                required:
                  - object
                  - url
                  - has_more
                  - data
                properties:
                  object:
                    type: string
                    description: Tipo do objeto. Sempre 'list'.
                    enum:
                      - list
                    example: list
                  url:
                    type: string
                    format: uri-reference
                    description: URL do recurso solicitado.
                    example: /api/v1/products
                  has_more:
                    type: boolean
                    description: Indica se há mais resultados disponíveis para paginação.
                    example: false
                  data:
                    type: array
                    description: Lista de produtos.
                    items:
                      type: object
                      unevaluatedProperties: false
                      required:
                        - id
                        - object
                        - active
                        - created
                        - live_mode
                        - name
                      properties:
                        id:
                          type: string
                          pattern: ^prod_[0-9a-z]{26}$
                          readOnly: true
                          description: >-
                            ID único do produto, no formato TypeID com prefixo
                            `prod_`.
                          example: prod_01h455vb4pex5vsknk084sn02q
                        object:
                          type: string
                          description: Tipo do objeto. Sempre 'product'.
                          enum:
                            - product
                          example: product
                        active:
                          type: boolean
                          description: Se o produto está disponível para compra.
                          example: true
                        created:
                          type: integer
                          format: int64
                          readOnly: true
                          description: Timestamp Unix de quando o produto foi criado.
                          example: 1680893993
                        live_mode:
                          type: boolean
                          description: >-
                            Indica ambiente de produção (true) ou sandbox
                            (false). Dados de sandbox são limpos periodicamente.
                          example: false
                        name:
                          type: string
                          description: Nome do produto.
                          example: Plano Premium
                        description:
                          type:
                            - string
                            - 'null'
                          nullable: true
                          description: Descrição do produto.
                          example: Acesso a todas as funcionalidades premium
                        external_code:
                          type:
                            - string
                            - 'null'
                          nullable: true
                          description: >-
                            Código externo para integração. Deve ser único por
                            conta.
                          example: prod_premium
        '404':
          description: Não encontrado
          content:
            application/problem+json:
              schema:
                type: object
                required:
                  - type
                  - status
                  - title
                  - detail
                  - code
                properties:
                  type:
                    type: string
                    description: URI que identifica o tipo de problema
                    format: uri
                    enum:
                      - https://problems-registry.smartbear.com/not-found
                  status:
                    type: integer
                    description: O código de status HTTP
                    format: int32
                    enum:
                      - 404
                  title:
                    type: string
                    description: O nome do status HTTP
                    enum:
                      - Not Found
                  detail:
                    type: string
                    description: Mensagem descritiva do erro
                  code:
                    type: string
                    description: Código de erro interno da API
                    enum:
                      - NOT_FOUND
                      - RESOURCE_MISSING
              examples:
                not_found:
                  summary: Recurso não encontrado
                  value:
                    type: https://problems-registry.smartbear.com/not-found
                    status: 404
                    title: Not Found
                    detail: The requested resource was not found
                    code: NOT_FOUND
                customer_not_found:
                  summary: Cliente não encontrado
                  value:
                    type: https://problems-registry.smartbear.com/not-found
                    status: 404
                    title: Not Found
                    detail: 'No such customer: ''019abc12-3456-7890-abcd-ef1234567890'''
                    code: RESOURCE_MISSING
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >
        A chave de API usada para autenticar a requisição e identificar a sua
        conta.


        **Exemplo:** `Authorization: ApiKey my-secure-key`

````