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

# List Products

> Lists all products in the account catalog. Requires `products.read`.



## OpenAPI

````yaml /api-reference/openapi/EvoAI-CRM-Service/products.yaml get /api/v1/products
openapi: 3.0.4
info:
  title: Evolution Foundation - CRM Service - Products
  description: >
    Product catalog management with variants, agent attach, and pipeline sales
    tracking.


    Available starting `v1.0.0-rc3`.


    **Note:** This OpenAPI spec was generated from the controller as part of the
    rc3 release. Schemas reflect the controller surface but request/response
    examples may need refinement based on real payloads.
  version: 1.0.0
servers:
  - url: https://api.evoai.app
    description: Production server
  - url: http://localhost:3000
    description: Development server
  - url: '{customUrl}'
    description: Custom server
    variables:
      customUrl:
        default: https://your-instance.com
        description: Enter your server URL
security: []
paths:
  /api/v1/products:
    get:
      summary: List Products
      description: Lists all products in the account catalog. Requires `products.read`.
      operationId: list-products
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
        - name: per_page
          in: query
          schema:
            type: integer
            default: 25
        - name: status
          in: query
          description: Filter by status (`active` or `inactive`)
          schema:
            type: string
            enum:
              - active
              - inactive
        - name: q
          in: query
          description: Search by name or SKU
          schema:
            type: string
      responses:
        '200':
          description: Products retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      security:
        - userApiKey: []
components:
  schemas:
    ProductListResponse:
      type: object
      required:
        - success
        - data
        - meta
        - message
      properties:
        success:
          type: boolean
          example: true
        data:
          type: array
          items:
            $ref: '#/components/schemas/Product'
        meta:
          type: object
          properties:
            timestamp:
              type: string
              format: date-time
            pagination:
              type: object
              properties:
                current_page:
                  type: integer
                total_pages:
                  type: integer
                total_count:
                  type: integer
        message:
          type: string
    Product:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        slug:
          type: string
        kind:
          type: string
        description:
          type: string
        sku:
          type: string
        default_price:
          type: number
          format: float
        currency:
          type: string
        status:
          type: string
          enum:
            - active
            - inactive
        stock_quantity:
          type: integer
        metadata:
          type: object
          additionalProperties: true
        labels:
          type: array
          items:
            type: string
        variants:
          type: array
          items:
            $ref: '#/components/schemas/Variant'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Variant:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        sku:
          type: string
        price_override:
          type: number
          format: float
        stock_quantity:
          type: integer
        position:
          type: integer
        attributes_data:
          type: object
          additionalProperties: true
  responses:
    Unauthorized:
      description: Missing or invalid authentication
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              message:
                type: string
                example: Unauthorized
    Forbidden:
      description: Insufficient permissions
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              message:
                type: string
                example: Forbidden
  securitySchemes:
    userApiKey:
      type: apiKey
      in: header
      name: api_access_token

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.