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

# List products

> Returns a paginated list of all products in the organization's catalog. Archived products are excluded.



## OpenAPI

````yaml /api-reference/openapi.json get /catalog/products/
openapi: 3.0.0
info:
  title: kelviq API
  version: 1.0.0
  description: >-
    API for interacting with kelviq services, derived from Python SDK
    documentation.
servers:
  - url: https://api.kelviq.com/api/v1
    description: kelviq API Server (General - specific operations might override)
security:
  - bearerAuth: []
tags:
  - name: Products
    description: Catalog products.
  - name: Product Settings
    description: Per-product settings (currency, VPN/Tor/proxy, product URL).
  - name: Product Files
    description: Product images and downloadable assets.
  - name: Features
    description: Catalog features that can be granted as plan entitlements.
  - name: Plans
    description: Catalog plans (CRUD, publish, versions, prices).
  - name: Plan Entitlements
    description: Feature entitlements attached to a plan.
  - name: Plan Files
    description: Files attached to plans, and signed download links.
  - name: Media
    description: Generate presigned S3 upload URLs for product/plan images and files.
  - name: Partner
    description: Partner integration APIs (organization provisioning, lookup).
  - name: Charges
    description: >-
      One-time payments charged immediately against a customer's default payment
      method.
paths:
  /catalog/products/:
    get:
      tags:
        - Products
      summary: List products
      description: >-
        Returns a paginated list of all products in the organization's catalog.
        Archived products are excluded.
      operationId: listCatalogProducts
      parameters:
        - name: search
          in: query
          required: false
          description: Free-text search across `name`, `identifier`, and `description`.
          example: pro
          schema:
            type: string
        - name: page
          in: query
          required: false
          description: Page number for pagination.
          example: 1
          schema:
            type: integer
      responses:
        '200':
          description: Paginated list of products.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedProducts'
        '401':
          description: Unauthorized — missing or invalid API key
      security:
        - bearerAuth: []
components:
  schemas:
    PaginatedProducts:
      type: object
      properties:
        count:
          type: integer
          example: 1
        next:
          type: string
          nullable: true
          example: null
        previous:
          type: string
          nullable: true
          example: null
        results:
          type: array
          items:
            $ref: '#/components/schemas/Product'
    Product:
      type: object
      description: >-
        A product in the catalog. Each product can have multiple plans, images
        and files.
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          example: 0d65f7c0-7e91-4f56-9b32-13a9a6a7c1de
        identifier:
          type: string
          description: >-
            Human-readable, URL-safe slug. Auto-generated from `name` if omitted
            on create.
          example: pro-suite
        name:
          type: string
          example: Pro Suite
        description:
          type: string
          example: Premium tools for growing teams.
        taxCode:
          type: string
          description: Tax code for the product. Must be one of the supported values.
          enum:
            - saas
            - saas_business
            - software
            - videocontent
            - informationservice
            - ebook
            - digitalgraphic
            - videogame
            - eservice
            - training
          example: saas
        createdBy:
          type: string
          readOnly: true
          description: Display name of the user who created the product.
          example: Jane Smith
        modifiedOn:
          type: string
          format: date-time
          readOnly: true
          example: '2025-04-12T08:21:14.910Z'
        images:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/ProductImage'
    ProductImage:
      type: object
      description: An image asset attached to a product.
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          description: Unique identifier for the image.
          example: 1f7e1b54-7c6f-4d7e-9a4f-2c9c2d8b9d31
        name:
          type: string
          nullable: true
          description: Original filename or display name.
          example: hero-banner.png
        image:
          type: string
          readOnly: true
          description: Storage key / URL for the image asset.
          example: media/.../products/<id>/<uuid>/hero-banner.png
        ordering:
          type: integer
          description: Position of the image in the gallery.
          example: 0
        thumbnail:
          type: boolean
          description: If `true`, this image is used as the product thumbnail.
          example: true
        enabled:
          type: boolean
          description: If `true`, the image is shown publicly.
          example: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        The Server API Key obtained from the kelviq application. Pass as a
        Bearer token in the Authorization header. Example: 'Authorization:
        Bearer __YOUR_API_KEY__'

````