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

# The part catalogue with total availability. api.inventory_available is stock per warehouse.



## OpenAPI

````yaml /api-reference/openapi.json get /parts
openapi: 3.0.0
info:
  description: ''
  title: >-
    The only schema PostgREST exposes (ADR-014). Reads are security_invoker
    views; writes are SECURITY DEFINER functions. Rebuilt wholesale on every
    deploy — it holds no data.
  version: 12.2.3
servers:
  - url: https://app.assetinfinity.ai/api
security: []
tags:
  - name: Signing in
  - name: Profile
  - name: Assets
  - name: Asset lifecycle
  - name: Work lifecycle
  - name: Maintenance
  - name: Inventory
  - name: Inventory detail
  - name: Procurement
  - name: Contracts
  - name: Workforce
  - name: Capacity
  - name: Dispatch
  - name: Routing
  - name: Tools
  - name: Inspections
  - name: Verification
  - name: Reliability
  - name: Parts demand
  - name: Sensors and meters
  - name: Map
  - name: Floor plans
  - name: Labels
  - name: Lost and found
  - name: Root cause analysis
  - name: Reports
  - name: Audit center
  - name: Activity
  - name: Notifications
  - name: Channels
  - name: Search
  - name: Copilot
  - name: Import
  - name: Files
  - name: Sync
  - name: Support
  - name: Admin
  - name: Access
  - name: Lookups
  - name: Read models
  - name: Branding
  - name: Custom fields
  - name: Form studio
  - name: Workflows
  - name: Workflow studio
  - name: Rules
  - name: Statuses and transitions
  - name: Currencies and locales
  - name: Work configuration
  - name: Asset configuration
  - name: Inventory configuration
  - name: Tool configuration
  - name: Workforce configuration
  - name: Vendor and contract configuration
  - name: Document configuration
  - name: Inspection configuration
  - name: Sites, locations and the organisation
  - name: Platform
  - name: Self verification
  - name: Setup
  - name: Tools on a job, and who has them out
  - name: Vendors and contracts
  - name: Work order execution
  - name: Workforce detail
externalDocs:
  description: PostgREST Documentation
  url: https://postgrest.org/en/v12/references/api.html
paths:
  /parts:
    get:
      tags:
        - Lookups
      summary: >-
        The part catalogue with total availability. api.inventory_available is
        stock per warehouse.
      parameters:
        - $ref: '#/components/parameters/rowFilter.parts.id'
        - $ref: '#/components/parameters/rowFilter.parts.part_number'
        - $ref: '#/components/parameters/rowFilter.parts.name'
        - $ref: '#/components/parameters/rowFilter.parts.description'
        - $ref: '#/components/parameters/rowFilter.parts.part_category'
        - $ref: '#/components/parameters/rowFilter.parts.unit_of_measure'
        - $ref: '#/components/parameters/rowFilter.parts.criticality'
        - $ref: '#/components/parameters/rowFilter.parts.tracking_mode'
        - $ref: '#/components/parameters/rowFilter.parts.is_stocked'
        - $ref: '#/components/parameters/rowFilter.parts.is_active'
        - $ref: '#/components/parameters/rowFilter.parts.on_hand_quantity'
        - $ref: '#/components/parameters/rowFilter.parts.reserved_quantity'
        - $ref: '#/components/parameters/rowFilter.parts.available_quantity'
        - $ref: '#/components/parameters/rowFilter.parts.on_order_quantity'
        - $ref: '#/components/parameters/rowFilter.parts.reorder_point'
        - $ref: '#/components/parameters/rowFilter.parts.at_or_below_reorder_point'
        - $ref: '#/components/parameters/rowFilter.parts.lead_time_days'
        - $ref: '#/components/parameters/rowFilter.parts.open_recommendations'
        - $ref: '#/components/parameters/rowFilter.parts.primary_image_file_id'
        - $ref: '#/components/parameters/rowFilter.parts.row_version'
        - $ref: '#/components/parameters/select'
        - $ref: '#/components/parameters/order'
        - $ref: '#/components/parameters/range'
        - $ref: '#/components/parameters/rangeUnit'
        - $ref: '#/components/parameters/offset'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/preferCount'
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/parts'
                type: array
            application/vnd.pgrst.object+json:
              schema:
                items:
                  $ref: '#/components/schemas/parts'
                type: array
            application/vnd.pgrst.object+json;nulls=stripped:
              schema:
                items:
                  $ref: '#/components/schemas/parts'
                type: array
            text/csv:
              schema:
                items:
                  $ref: '#/components/schemas/parts'
                type: array
          description: OK
        '206':
          description: Partial Content
components:
  parameters:
    rowFilter.parts.id:
      in: query
      name: id
      required: false
      schema:
        type: string
    rowFilter.parts.part_number:
      in: query
      name: part_number
      required: false
      schema:
        type: string
    rowFilter.parts.name:
      in: query
      name: name
      required: false
      schema:
        type: string
    rowFilter.parts.description:
      in: query
      name: description
      required: false
      schema:
        type: string
    rowFilter.parts.part_category:
      in: query
      name: part_category
      required: false
      schema:
        type: string
    rowFilter.parts.unit_of_measure:
      in: query
      name: unit_of_measure
      required: false
      schema:
        type: string
    rowFilter.parts.criticality:
      in: query
      name: criticality
      required: false
      schema:
        type: string
    rowFilter.parts.tracking_mode:
      in: query
      name: tracking_mode
      required: false
      schema:
        type: string
    rowFilter.parts.is_stocked:
      in: query
      name: is_stocked
      required: false
      schema:
        type: string
    rowFilter.parts.is_active:
      in: query
      name: is_active
      required: false
      schema:
        type: string
    rowFilter.parts.on_hand_quantity:
      in: query
      name: on_hand_quantity
      required: false
      schema:
        type: string
    rowFilter.parts.reserved_quantity:
      in: query
      name: reserved_quantity
      required: false
      schema:
        type: string
    rowFilter.parts.available_quantity:
      in: query
      name: available_quantity
      required: false
      schema:
        type: string
    rowFilter.parts.on_order_quantity:
      in: query
      name: on_order_quantity
      required: false
      schema:
        type: string
    rowFilter.parts.reorder_point:
      in: query
      name: reorder_point
      required: false
      schema:
        type: string
    rowFilter.parts.at_or_below_reorder_point:
      in: query
      name: at_or_below_reorder_point
      required: false
      schema:
        type: string
    rowFilter.parts.lead_time_days:
      in: query
      name: lead_time_days
      required: false
      schema:
        type: string
    rowFilter.parts.open_recommendations:
      in: query
      name: open_recommendations
      required: false
      schema:
        type: string
    rowFilter.parts.primary_image_file_id:
      in: query
      name: primary_image_file_id
      required: false
      schema:
        type: string
    rowFilter.parts.row_version:
      in: query
      name: row_version
      required: false
      schema:
        type: string
    select:
      description: Filtering Columns
      in: query
      name: select
      required: false
      schema:
        type: string
    order:
      description: Ordering
      in: query
      name: order
      required: false
      schema:
        type: string
    range:
      description: Limiting and Pagination
      in: header
      name: Range
      required: false
      schema:
        type: string
    rangeUnit:
      description: Limiting and Pagination
      in: header
      name: Range-Unit
      required: false
      schema:
        default: items
        type: string
    offset:
      description: Limiting and Pagination
      in: query
      name: offset
      required: false
      schema:
        type: string
    limit:
      description: Limiting and Pagination
      in: query
      name: limit
      required: false
      schema:
        type: string
    preferCount:
      description: Preference
      in: header
      name: Prefer
      required: false
      schema:
        enum:
          - count=none
        type: string
  schemas:
    parts:
      description: >-
        The part catalogue with total availability. api.inventory_available is
        stock per warehouse.
      properties:
        at_or_below_reorder_point:
          format: boolean
          type: boolean
        available_quantity:
          format: numeric
          type: number
        criticality:
          format: character varying
          maxLength: 20
          type: string
        description:
          format: text
          type: string
        id:
          description: |-
            Note:
            This is a Primary Key.<pk/>
          format: uuid
          type: string
        is_active:
          format: boolean
          type: boolean
        is_stocked:
          format: boolean
          type: boolean
        lead_time_days:
          format: integer
          type: integer
        name:
          format: character varying
          maxLength: 250
          type: string
        on_hand_quantity:
          format: numeric
          type: number
        on_order_quantity:
          format: numeric
          type: number
        open_recommendations:
          format: bigint
          type: integer
        part_category:
          format: character varying
          maxLength: 60
          type: string
        part_number:
          format: character varying
          maxLength: 80
          type: string
        primary_image_file_id:
          format: uuid
          type: string
        reorder_point:
          format: numeric
          type: number
        reserved_quantity:
          format: numeric
          type: number
        row_version:
          format: bigint
          type: integer
        tracking_mode:
          format: character varying
          maxLength: 20
          type: string
        unit_of_measure:
          format: character varying
          maxLength: 30
          type: string
      type: object

````

## Related topics

- [The part catalogue](/inventory/parts.md)
- [Inside a part](/inventory/part-detail.md)
- [Inventory settings](/config/inventory.md)
- [Reorder recommendations](/inventory/reorder.md)
- [The asset register](/assets/register.md)