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

# List products

> Returns a paginated list of products in the workspace.

<Accordion title="Required scope">
`products:read`
</Accordion>



## OpenAPI

````yaml /en/api-reference/openapi.json get /v1/products
openapi: 3.1.0
info:
  title: OAuth 2.1
  description: Endpoints for registering applications and managing OAuth 2.1 tokens.
  version: 1.0.0
  contact:
    name: Vendaze Support
    email: suporte@vendaze.com
servers:
  - url: https://api.vendaze.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: OAuth
  - name: People
  - name: Companies
  - name: Deals
  - name: Pipelines
  - name: Tasks
  - name: Task Types
  - name: Products
  - name: Tags
  - name: Lists
  - name: Custom Fields
  - name: Webhooks
paths:
  /v1/products:
    get:
      tags:
        - Products
      summary: List products
      description: |-
        Returns a paginated list of products in the workspace.

        <Accordion title="Required scope">
        `products:read`
        </Accordion>
      operationId: listProducts
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            minimum: 1
            default: 1
          description: Page number.
        - name: per_page
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 50
            default: 50
          description: 'Number of records per page. Maximum: 50.'
        - name: order_by
          in: query
          schema:
            type: string
            enum:
              - created_at
              - name
            default: created_at
          description: Field to sort by.
        - name: order
          in: query
          schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
          description: Sort direction.
        - name: name
          in: query
          schema:
            type: string
          description: Filter by product name (case-insensitive contains).
        - name: is_active
          in: query
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
          description: Filter by active status.
        - name: currency
          in: query
          schema:
            type: string
            pattern: ^[A-Z]{3}$
          description: Filter by ISO 4217 currency code (e.g. `BRL`, `USD`).
        - name: billing_cycle
          in: query
          schema:
            type: string
            enum:
              - monthly
              - yearly
              - weekly
              - daily
              - one_time
          description: Filter by billing cycle.
      responses:
        '200':
          description: Products returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductsListResponse'
              example:
                data:
                  - id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                    name: Enterprise Plan
                    price_cts: 99900
                    currency: USD
                    description: Full-featured plan for large teams.
                    image_url: >-
                      https://storage.vendaze.com/client/workspaces/abc/products/xyz/image/avatar_Ab1Cd2Ef3G.webp
                    code: PLAN-ENT
                    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: Unique identifier.
        name:
          type: string
          maxLength: 80
          description: Product name.
          example: Enterprise Plan
        price_cts:
          type: integer
          description: Price in the smallest currency unit (e.g. cents). `99900` = $999.00.
          example: 99900
        currency:
          $ref: '#/components/schemas/CurrencyCode'
        description:
          type: string
          nullable: true
          maxLength: 1000
          description: Optional product description.
          example: Full-featured plan for large teams.
        image_url:
          type: string
          nullable: true
          description: Public URL of the product image, or `null` if none.
          example: >-
            https://storage.vendaze.com/client/workspaces/abc/products/xyz/image/avatar_Ab1Cd2Ef3G.webp
        code:
          type: string
          nullable: true
          maxLength: 60
          description: Internal product code or SKU.
          example: PLAN-ENT
        is_active:
          type: boolean
          description: Whether the product is active.
          example: true
        billing_cycle:
          type: string
          enum:
            - one_time
            - monthly
            - quarterly
            - annually
          description: Billing cycle for the product.
          example: monthly
        created_at:
          type: string
          format: date-time
          description: ISO 8601 UTC creation timestamp.
    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: ISO 4217 currency code supported by 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: USD
  responses:
    Unauthorized:
      description: >-
        Token missing, invalid, or expired. Possible error codes:
        `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 lacks the required scope. Error code: `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: >-
        Input validation failed. Error code: `validation_error`. The `fields`
        object maps each invalid field to a description of the problem.
      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 exceeded. Error code: `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: 'Unexpected server error. Error code: `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: OAuth 2.1 access token.

````