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

# Listar produtos

> Retorna uma lista paginada de produtos do workspace.

<Accordion title="Escopo necessário">
`products:read`
</Accordion>



## OpenAPI

````yaml /pt/api-reference/openapi.json get /v1/products
openapi: 3.1.0
info:
  title: OAuth 2.1
  description: Endpoints para registrar aplicativos e gerenciar tokens OAuth 2.1.
  version: 1.0.0
  contact:
    name: Suporte Vendaze
    email: suporte@vendaze.com
servers:
  - url: https://api.vendaze.com
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: OAuth
  - name: Pessoas
  - name: Empresas
  - name: Negócios
  - name: Pipelines
  - name: Tarefas
  - name: Tipos de Tarefas
  - name: Produtos
  - name: Tags
  - name: Listas
  - name: Campos Adicionais
  - name: Webhooks
paths:
  /v1/products:
    get:
      tags:
        - Produtos
      summary: Listar produtos
      description: |-
        Retorna uma lista paginada de produtos do workspace.

        <Accordion title="Escopo necessário">
        `products:read`
        </Accordion>
      operationId: listProducts
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            minimum: 1
            default: 1
          description: Número da página.
        - name: per_page
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 50
            default: 50
          description: 'Registros por página. Máximo: 50.'
        - name: order_by
          in: query
          schema:
            type: string
            enum:
              - created_at
              - name
            default: created_at
          description: Campo de ordenação.
        - name: order
          in: query
          schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
          description: Direção da ordenação.
        - name: name
          in: query
          schema:
            type: string
          description: Filtrar por nome do produto (contém, sem distinção de maiúsculas).
        - name: is_active
          in: query
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
          description: Filtrar por status de ativo.
        - name: currency
          in: query
          schema:
            type: string
            pattern: ^[A-Z]{3}$
          description: 'Filtrar por código ISO 4217 da moeda (ex: `BRL`, `USD`).'
        - name: billing_cycle
          in: query
          schema:
            type: string
            enum:
              - monthly
              - yearly
              - weekly
              - daily
              - one_time
          description: Filtrar por ciclo de cobrança.
      responses:
        '200':
          description: Produtos retornados com sucesso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductsListResponse'
              example:
                data:
                  - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                    name: Plano Empresarial
                    price_cts: 99900
                    currency: BRL
                    description: Plano completo para grandes equipes.
                    image_url: >-
                      https://storage.vendaze.com/client/workspaces/abc/products/xyz/image/avatar_Ab1Cd2Ef3G.webp
                    code: PLANO-EMP
                    is_active: true
                    billing_cycle: monthly
                    created_at: '2026-01-15T10:30:00Z'
                meta:
                  total: 8
                  page: 1
                  per_page: 50
                  has_more: false
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/InsufficientScope'
        '422':
          $ref: '#/components/responses/ValidationError'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    ProductsListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Product'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
    Product:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Identificador único.
        name:
          type: string
          maxLength: 80
          description: Nome do produto.
          example: Plano Empresarial
        price_cts:
          type: integer
          description: >-
            Preço em centavos da menor unidade monetária. Ex: `99900` = R$
            999,00.
          example: 99900
        currency:
          $ref: '#/components/schemas/CurrencyCode'
        description:
          type: string
          nullable: true
          maxLength: 1000
          description: Descrição opcional do produto.
          example: Plano completo para grandes equipes.
        image_url:
          type: string
          nullable: true
          description: URL pública da imagem do produto, ou `null` se não houver.
          example: >-
            https://storage.vendaze.com/client/workspaces/abc/products/xyz/image/avatar_Ab1Cd2Ef3G.webp
        code:
          type: string
          nullable: true
          maxLength: 60
          description: Código interno ou SKU do produto.
          example: PLANO-EMP
        is_active:
          type: boolean
          description: Se o produto está ativo.
          example: true
        billing_cycle:
          type: string
          enum:
            - one_time
            - monthly
            - quarterly
            - annually
          description: Ciclo de cobrança do produto.
          example: monthly
        created_at:
          type: string
          format: date-time
          description: Data de criação em ISO 8601 UTC.
    PaginationMeta:
      type: object
      properties:
        total:
          type: integer
          example: 1
        page:
          type: integer
          example: 1
        per_page:
          type: integer
          example: 50
        has_more:
          type: boolean
          example: false
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            request_id:
              type: string
              format: uuid
    ValidationErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: validation_error
            message:
              type: string
              example: Validation failed.
            fields:
              type: object
              additionalProperties:
                type: string
            request_id:
              type: string
              format: uuid
    CurrencyCode:
      type: string
      description: Código ISO 4217 de moeda suportado pela Vendaze.
      enum:
        - AED
        - ARS
        - AUD
        - BRL
        - CAD
        - CHF
        - CLP
        - CNY
        - COP
        - DKK
        - EGP
        - EUR
        - GBP
        - HKD
        - ILS
        - INR
        - JPY
        - KWD
        - MAD
        - MXN
        - MYR
        - NGN
        - NOK
        - NZD
        - PEN
        - QAR
        - SAR
        - SEK
        - SGD
        - TRY
        - USD
        - UYU
        - ZAR
      example: BRL
  responses:
    Unauthorized:
      description: >-
        Token ausente, inválido ou expirado. Códigos possíveis: `unauthorized`,
        `token_expired`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: unauthorized
              message: Missing or invalid Authorization header.
              request_id: 550e8400-e29b-41d4-a716-446655440000
    InsufficientScope:
      description: 'Token sem o escopo necessário. Código de erro: `insufficient_scope`.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: insufficient_scope
              message: This endpoint requires the 'webhooks:read' scope.
              request_id: 550e8400-e29b-41d4-a716-446655440000
    ValidationError:
      description: >-
        Validação de entrada falhou. Código: `validation_error`. O objeto
        `fields` mapeia cada campo inválido para uma descrição do problema.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationErrorResponse'
          example:
            error:
              code: validation_error
              message: Validation failed.
              fields:
                url: url must use HTTPS.
                events: At least one event is required.
              request_id: 550e8400-e29b-41d4-a716-446655440000
    RateLimitExceeded:
      description: 'Rate limit excedido. Código: `rate_limit_exceeded`.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: rate_limit_exceeded
              message: Rate limit exceeded. Try again in 60 seconds.
              request_id: 550e8400-e29b-41d4-a716-446655440000
    InternalError:
      description: 'Erro interno inesperado. Código: `internal_error`.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: internal_error
              message: An unexpected error occurred.
              request_id: 550e8400-e29b-41d4-a716-446655440000
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Access token OAuth 2.1.

````