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

# List All Products

> List All Products



## OpenAPI

````yaml openapi.json get /v1/products
openapi: 3.1.0
info:
  title: Trata AI API
  description: >-
    Human like conversation to answer calls, drive engagement, automate
    follow-ups & schedule bookings 24/7  with end to end integrations ensuring
    you never miss a sales enquiry.
  version: 1.0.0
servers:
  - url: https://api.trata.ai
    description: Production
  - url: http://localhost:8000
    description: Development
security: []
paths:
  /v1/products:
    get:
      tags:
        - Products
      summary: List All Products
      description: List All Products
      operationId: listProductsV1
      parameters:
        - name: search_by
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Field name to search by
            title: Search By
          description: Field name to search by
          example: name
        - name: search_value
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Value to search for in the specified field
            title: Search Value
          description: Value to search for in the specified field
          example: search term
        - name: status
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Filter by status
            title: Status
          description: Filter by status
          example: active
        - name: sort_by
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Field to sort by
            title: Sort By
          description: Field to sort by
          example: createdAt
        - name: sort_order
          in: query
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/SortOrder'
              - type: 'null'
            description: Sort order (asc or desc)
            default: asc
            title: Sort Order
          description: Sort order (asc or desc)
        - name: skip
          in: query
          required: false
          schema:
            type: integer
            minimum: 0
            description: Number of records to skip
            default: 0
            title: Skip
          description: Number of records to skip
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: Maximum number of records to return
            default: 100
            title: Limit
          description: Maximum number of records to return
        - name: tags
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
            description: Filter products by specific tags
            title: Tags
          description: Filter products by specific tags
          example:
            - electronics
            - accessories
        - name: product_ids
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
            description: Filter by specific product IDs
            title: Product Ids
          description: Filter by specific product IDs
          example:
            - prod_123
            - prod_456
      responses:
        '200':
          description: List of products retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Product-Output'
                title: Response Listproductsv1
              example:
                id: pro.1731301754.OZSMSU1S
                orgId: org.1726902940.GZChqlpU
                active: true
                defaultPrice: 1299
                currency: USD
                description: Spicy Korean Chicken Wings
                name: Spicy Korean Chicken Wings
                shippable: true
                features: []
                scheduleAppointment: false
                props: {}
                status: active
                createdBy: trata-system
                createdAt: '2024-11-11T05:09:14.979287'
                updatedBy: trata-system
                updatedAt: '2024-11-11T05:09:14.979289'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    SortOrder:
      type: string
      enum:
        - asc
        - desc
      title: SortOrder
    Product-Output:
      properties:
        id:
          type: string
          title: Id
        orgId:
          type: string
          title: Orgid
        active:
          type: boolean
          title: Active
          description: Product is active or not
          default: false
        defaultPrice:
          anyOf:
            - type: integer
            - type: 'null'
          title: Defaultprice
          description: >-
            Default price of the product this is represented in the lowest
            currency denomination. Eg: 1000 for $10
        currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Currency
        description:
          anyOf:
            - type: string
              maxLength: 256
              minLength: 1
            - type: 'null'
          title: Description
          description: Description of the product
        name:
          type: string
          maxLength: 256
          minLength: 1
          title: Name
          description: Name of the product
        shippable:
          type: boolean
          title: Shippable
          description: Product is shippable or not. Service is not shippable
          default: false
        features:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Features
          description: List of features of the product
        scheduleAppointment:
          type: boolean
          title: Scheduleappointment
          description: Product requires appointment scheduling or not
          default: false
        props:
          anyOf:
            - type: object
            - type: 'null'
          title: Props
          description: Properties of the product
        tags:
          anyOf:
            - items:
                type: string
              type: array
              uniqueItems: true
            - type: 'null'
          title: Tags
        status:
          type: string
          title: Status
        createdBy:
          type: string
          title: Createdby
        createdAt:
          type: string
          format: date-time
          title: Createdat
        updatedBy:
          type: string
          title: Updatedby
        updatedAt:
          type: string
          format: date-time
          title: Updatedat
      type: object
      required:
        - status
      title: Product
      description: Product and services offered by the business
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````