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

# List Products

> Get paginated list of products in a catalog



## OpenAPI

````yaml GET /organizations/{orgId}/catalogs/{catalogId}/products
openapi: 3.1.0
info:
  title: Refine API
  description: >-
    API for managing product catalogs and delivering AI-powered product
    recommendations and search
  version: 1.0.0
  contact:
    name: Refine Support
    email: support@refine.ai
servers:
  - url: https://api.joinrefine.io
    description: Production server
security:
  - apiKey: []
paths:
  /organizations/{orgId}/catalogs/{catalogId}/products:
    get:
      tags:
        - Product Operations
      summary: List Products
      description: Get paginated list of products in a catalog
      operationId: listProducts
      parameters:
        - name: orgId
          in: path
          required: true
          description: Organization ID (UUID)
          schema:
            type: string
            format: uuid
        - name: catalogId
          in: path
          required: true
          description: Catalog ID (UUID)
          schema:
            type: string
            format: uuid
        - name: page
          in: query
          description: Page number
          schema:
            type: integer
            default: 1
            minimum: 1
        - name: page_size
          in: query
          description: Items per page
          schema:
            type: integer
            default: 25
            minimum: 1
            maximum: 100
        - name: search_query
          in: query
          description: Search in descriptor, URLs, and metadata
          schema:
            type: string
        - name: product_rank
          in: query
          description: Filter by product rank
          schema:
            type: string
            enum:
              - NO_BOOST
              - BOOST
              - SUPER_BOOST
        - name: status
          in: query
          description: Filter by product status
          schema:
            type: string
            enum:
              - PROCESSING
              - PROCESSED
              - ERROR
        - name: created_after
          in: query
          description: Filter products created after this date (RFC3339)
          schema:
            type: string
            format: date-time
        - name: created_before
          in: query
          description: Filter products created before this date (RFC3339)
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: Paginated list of products
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedProductResponse'
        '400':
          description: Bad Request - Invalid UUID format
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Forbidden - Catalog doesn't belong to organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    PaginatedProductResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Product'
        pagination:
          type: object
          properties:
            total_items:
              type: integer
              description: Total number of products
            total_pages:
              type: integer
              description: Total number of pages
            current_page:
              type: integer
              description: Current page number
            page_size:
              type: integer
              description: Items per page
            has_next:
              type: boolean
              description: Whether there is a next page
            has_previous:
              type: boolean
              description: Whether there is a previous page
    Error:
      type: object
      required:
        - status
        - message
        - time
        - method
        - url
      properties:
        status:
          type: integer
          description: HTTP status code
        message:
          type: string
          description: Error message
        time:
          type: string
          format: date-time
          description: Timestamp in RFC3339 format
        method:
          type: string
          description: HTTP method
        url:
          type: string
          description: Request URL
    Product:
      type: object
      properties:
        id:
          type: string
          description: Product ID
        catalogId:
          type: string
          format: uuid
          description: Catalog ID
        imageUrl:
          type: string
          format: uri
          description: Product image URL
        objectUrl:
          type: string
          description: Internal object storage URL
        descriptor:
          type: string
          description: Product description (lowercase)
        metadata:
          type: object
          description: Product metadata
        createAt:
          type: string
          format: date-time
          description: Creation timestamp
        status:
          type: string
          enum:
            - PROCESSING
            - PROCESSED
            - ERROR
          description: Processing status
        rank:
          type: string
          enum:
            - NO_BOOST
            - BOOST
            - SUPER_BOOST
          description: Ranking boost level
        updateAt:
          type: string
          format: date-time
          description: Last update timestamp
  responses:
    Unauthorized:
      description: Unauthorized - Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            status: 401
            message: Unauthorized
            time: '2024-06-14T19:21:00Z'
            method: GET
            url: /organizations/a8cd2722-1234-4567-9abc-def123456789/catalogs
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: REFINE_API_KEY
      description: API key for authentication

````