> ## 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.

# List parts

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



## OpenAPI

````yaml /api-reference/integration.json get /parts
openapi: 3.0.0
info:
  description: >-
    The calls an integration needs first. Every endpoint the application uses is
    in the complete reference.
  title: Asset Infinity integration API
  version: 12.2.3
servers:
  - url: https://app.assetinfinity.ai/api
security: []
tags:
  - description: >-
      Exchange an API key, or an email and password, for a short-lived session
      token, and send it as `Authorization: Bearer <token>` on every other call.
    name: Signing in
  - description: >-
      Where assets are and work happens. A location belongs to a site and may
      sit inside another location.
    name: Sites and locations
  - description: >-
      The asset register: read it, add to it, correct it, move an asset between
      sites and locations, and change its status.
    name: Assets
  - description: >-
      Report a problem. A request is triaged by a person, who turns it into a
      work order or turns it down.
    name: Work requests
  - description: >-
      Raise a job, give it to somebody, move it through the organisation's
      statuses, complete it and close it.
    name: Work orders
  - description: >-
      Send readings in. A meter reading brings the meter forward and raises any
      maintenance the usage has made due. A sensor reading can open or clear an
      alert.
    name: Meters and sensors
  - description: >-
      The part catalogue and what is on the shelf in each store, and the three
      movements an outside system most often records: a delivery in, an issue
      out and a correction.
    name: Parts and stock
  - description: >-
      Have the product call your system when something happens, instead of
      asking it on a timer.
    name: Webhooks
  - description: >-
      The calls behind every register that has no call of its own, answers to
      the organisation's own fields, and the two calls that answer what to send.
      `list_options` returns the ids a field accepts. `describe_call` returns
      the fields any call takes.
    name: Any record
externalDocs:
  description: PostgREST Documentation
  url: https://postgrest.org/en/v12/references/api.html
paths:
  /parts:
    get:
      tags:
        - Parts and stock
      summary: List parts
      description: >-
        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_consumable'
        - $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.shortages_12m'
        - $ref: '#/components/parameters/rowFilter.parts.shortages_that_stopped_work'
        - $ref: '#/components/parameters/rowFilter.parts.row_version'
        - $ref: '#/components/parameters/rowFilter.parts.created_at'
        - $ref: '#/components/parameters/rowFilter.parts.created_by_id'
        - $ref: '#/components/parameters/rowFilter.parts.created_by_name'
        - $ref: '#/components/parameters/rowFilter.parts.created_source'
        - $ref: '#/components/parameters/rowFilter.parts.updated_at'
        - $ref: '#/components/parameters/rowFilter.parts.updated_by_id'
        - $ref: '#/components/parameters/rowFilter.parts.updated_by_name'
        - $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_consumable:
      in: query
      name: is_consumable
      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.shortages_12m:
      in: query
      name: shortages_12m
      required: false
      schema:
        type: string
    rowFilter.parts.shortages_that_stopped_work:
      in: query
      name: shortages_that_stopped_work
      required: false
      schema:
        type: string
    rowFilter.parts.row_version:
      in: query
      name: row_version
      required: false
      schema:
        type: string
    rowFilter.parts.created_at:
      in: query
      name: created_at
      required: false
      schema:
        type: string
    rowFilter.parts.created_by_id:
      in: query
      name: created_by_id
      required: false
      schema:
        type: string
    rowFilter.parts.created_by_name:
      in: query
      name: created_by_name
      required: false
      schema:
        type: string
    rowFilter.parts.created_source:
      in: query
      name: created_source
      required: false
      schema:
        type: string
    rowFilter.parts.updated_at:
      in: query
      name: updated_at
      required: false
      schema:
        type: string
    rowFilter.parts.updated_by_id:
      in: query
      name: updated_by_id
      required: false
      schema:
        type: string
    rowFilter.parts.updated_by_name:
      in: query
      name: updated_by_name
      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
        created_at:
          format: timestamp with time zone
          type: string
        created_by_id:
          description: >-
            Note:

            This is a Foreign Key to `capex_invite_candidates.id`.<fk
            table='capex_invite_candidates' column='id'/>
          format: uuid
          type: string
        created_by_name:
          format: character varying
          maxLength: 200
          type: string
        created_source:
          format: text
          type: string
        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_consumable:
          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
        shortages_12m:
          format: bigint
          type: integer
        shortages_that_stopped_work:
          format: bigint
          type: integer
        tracking_mode:
          format: character varying
          maxLength: 20
          type: string
        unit_of_measure:
          format: character varying
          maxLength: 30
          type: string
        updated_at:
          format: timestamp with time zone
          type: string
        updated_by_id:
          description: >-
            Note:

            This is a Foreign Key to `capex_invite_candidates.id`.<fk
            table='capex_invite_candidates' column='id'/>
          format: uuid
          type: string
        updated_by_name:
          format: character varying
          maxLength: 200
          type: string
      type: object

````

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