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

# List items at or below their low-stock threshold

> Returns active finished-goods rows where `ready_stock <= low_stock_threshold`, ordered by largest deficit first. Includes the parent `product_name` to save a lookup. Excludes composite kits whose buildable stock keeps their `effective_status` at `in_stock` — otherwise every kit parent at `ready_stock=0` would alert even when hundreds of kits are buildable from on-hand parts.



## OpenAPI

````yaml /api-reference/openapi.json get /inventory/alerts
openapi: 3.1.0
info:
  title: AutoPrintFarm Public API
  version: 1.0.0
  description: >-
    Public API for AutoPrintFarm — read + write surface for printers, jobs,
    inventory, orders, SKUs, files, worklist, and assembly. Authorization uses
    three scopes: `read` (any list/get), `write` (data mutations — create,
    update, delete, uploads, fulfillment), and `control` (physical printer
    actions: start, pause, resume, stop, heaters, light, filament). Authenticate
    with an API key minted from Settings → API Keys in the AutoPrintFarm
    dashboard.
  contact:
    name: AutoPrintFarm
    url: https://autoprintfarm.com
servers:
  - url: https://api.autoprintfarm.com/public/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Printers
    description: Printer fleet status
  - name: Jobs
    description: Print job queue and history
  - name: Inventory
    description: Finished-goods stock levels
  - name: Orders
    description: Customer orders and line items
  - name: Wiki
    description: Internal documentation articles
  - name: Worklist
    description: Operational task queue
  - name: Products
    description: Product catalog, SKUs, components, and color presets
  - name: Files
    description: Print file metadata and versions
  - name: Hubs
    description: Hub fleet and connection status
  - name: Assembly
    description: Post-print assembly tasks with bundled wiki
  - name: Materials
    description: Filament, components, packaging, and printer parts inventory
  - name: Analytics
    description: >-
      Dashboard rollups and reporting (overview, production, printers, failures,
      inventory, revenue)
paths:
  /inventory/alerts:
    get:
      tags:
        - Inventory
      summary: List items at or below their low-stock threshold
      description: >-
        Returns active finished-goods rows where `ready_stock <=
        low_stock_threshold`, ordered by largest deficit first. Includes the
        parent `product_name` to save a lookup. Excludes composite kits whose
        buildable stock keeps their `effective_status` at `in_stock` — otherwise
        every kit parent at `ready_stock=0` would alert even when hundreds of
        kits are buildable from on-hand parts.
      responses:
        '200':
          description: Low-stock alerts
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/InventoryAlert'
                required:
                  - success
                  - data
        '401':
          description: Missing, invalid, revoked, or expired API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: API key lacks the required scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded (120 req/min/key)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth:
            - read
components:
  schemas:
    InventoryAlert:
      type: object
      properties:
        id:
          type: string
        product_sku_id:
          type: string
        sku:
          type: string
        color:
          type: string
        material:
          type: string
        ready_stock:
          type: number
        low_stock_threshold:
          type:
            - number
            - 'null'
        status:
          type:
            - string
            - 'null'
        image_url:
          type:
            - string
            - 'null'
        is_active:
          type:
            - boolean
            - 'null'
        created_at:
          type:
            - string
            - 'null'
        updated_at:
          type:
            - string
            - 'null'
        product_name:
          type:
            - string
            - 'null'
      required:
        - id
        - product_sku_id
        - sku
        - color
        - material
        - ready_stock
        - low_stock_threshold
        - status
        - image_url
        - is_active
        - created_at
        - updated_at
        - product_name
    Error:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        error:
          type: object
          properties:
            code:
              type: string
              description: >-
                Machine-readable error code (e.g. NOT_FOUND, VALIDATION_ERROR,
                FORBIDDEN, HUB_OFFLINE). Stable across releases — use this for
                branching.
              example: NOT_FOUND
            message:
              type: string
              description: >-
                Human-readable error message. May vary across releases — do not
                branch on this.
              example: Resource not found
            details:
              description: >-
                Optional structured detail. For VALIDATION_ERROR this is `{
                field: [messages] }`.
          required:
            - code
            - message
          description: Error detail object
      required:
        - success
        - error
      description: Standard error response envelope
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: apf_live_<64 hex>
      description: >-
        API keys are minted in the AutoPrintFarm web app under Settings → API
        Keys. Send as `Authorization: Bearer apf_live_...`. Keys are shown
        exactly once at creation and can be revoked at any time.

````