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

# List inventory level configurations for the authenticated organization

> Returns a paginated list of inventory level configurations (min/max stock rules) for the caller's organization. Each record defines the minimum and maximum quantity thresholds for a specific SKU at a specific warehouse. Supports filtering by SKU, warehouse, region, category, brand, and active status.



## OpenAPI

````yaml /openapi.json get /api/v1/inventory-levels
openapi: 3.1.0
info:
  title: Firstbase API Specification Beta
  description: Integration endpoints for Firstbase
  version: 0.1.0
servers:
  - url: /
    description: Default
security:
  - ApiKey: []
tags:
  - name: Inventory Orders
    description: Create and manage inventory orders
  - name: Shipment Notices V1
    description: 'Query shipment notice orders (V1: package items expose `inventories` list)'
  - name: Packages
    description: ''
  - name: Categories
    description: Query available categories for asset creation
  - name: Catalog
    description: ''
  - name: New Joiners
    description: New joiner provisioning pipeline for the organization
  - name: Orders
    description: ''
  - name: People
    description: >-
      Manage the users of Firstbase for your organization. API follows the SCIM
      standard.
    externalDocs:
      url: https://scim.cloud/
  - name: People — Lifecycle
    description: Offboard and reactivate users.
  - name: Assets
    description: Manage inventory assets
  - name: Regions V1
    description: Query regions (V1)
  - name: Warehouses V1
    description: Query warehouses (V1)
  - name: Brands
    description: Query available brands for asset creation
  - name: Inventory
    description: ''
  - name: Replacements
    description: Create and manage equipment replacements
  - name: Offices
    description: Manage and query office locations for the authenticated organization
  - name: Returns
    description: Return and Replacements
paths:
  /api/v1/inventory-levels:
    get:
      tags:
        - Inventory Levels
      summary: List inventory level configurations for the authenticated organization
      description: >-
        Returns a paginated list of inventory level configurations (min/max
        stock rules) for the caller's organization. Each record defines the
        minimum and maximum quantity thresholds for a specific SKU at a specific
        warehouse. Supports filtering by SKU, warehouse, region, category,
        brand, and active status.
      operationId: listInventoryLevels
      parameters:
        - name: page
          in: query
          description: 'Page number (1-based, default: 1)'
          required: false
          schema:
            type: integer
            format: int32
            default: 1
          example: 1
        - name: size
          in: query
          description: 'Number of results per page (max: 1000, default: 100)'
          required: false
          schema:
            type: integer
            format: int32
            default: 100
          example: 100
        - name: skuIds
          in: query
          description: Filter by one or more SKU IDs
          required: false
          schema:
            type: array
            items:
              type: string
              format: uuid
        - name: warehouseIds
          in: query
          description: Filter by one or more warehouse IDs
          required: false
          schema:
            type: array
            items:
              type: string
              format: uuid
        - name: regionIds
          in: query
          description: Filter by one or more region IDs
          required: false
          schema:
            type: array
            items:
              type: string
              format: uuid
        - name: categories
          in: query
          description: >-
            Filter by one or more product category codes (e.g. COMPUTER,
            MONITOR)
          required: false
          schema:
            type: array
            items:
              type: string
        - name: brands
          in: query
          description: Filter by one or more vendor/brand codes
          required: false
          schema:
            type: array
            items:
              type: string
        - name: searchString
          in: query
          description: Search by product title (partial match)
          required: false
          schema:
            type: string
        - name: active
          in: query
          description: >-
            Filter by active status — true returns active levels only, false
            returns inactive only (default: true)
          required: false
          schema:
            type: boolean
            default: true
      responses:
        '200':
          description: >-
            Paginated list of inventory level configurations with current stock
            details
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/InventoryLevelResponse'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PublicApiHttpErrors'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PublicApiHttpErrors'
        '409':
          description: Conflict
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PublicApiHttpErrors'
components:
  schemas:
    InventoryLevelResponse:
      type: object
      description: >-
        Inventory level configuration with current stock details for a specific
        SKU, warehouse, and region
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for this inventory level configuration
          example: 123e4567-e89b-12d3-a456-426614174000
        skuId:
          type: string
          format: uuid
          description: ID of the SKU whose stock level this configuration controls
          example: 123e4567-e89b-12d3-a456-426614174000
        warehouseId:
          type: string
          format: uuid
          description: ID of the warehouse where this inventory level applies
          example: 123e4567-e89b-12d3-a456-426614174000
        regionId:
          type: string
          format: uuid
          description: >-
            ID of the region scope for this inventory level; null means the
            organization's default region
          example: 123e4567-e89b-12d3-a456-426614174000
        minQuantity:
          type: integer
          format: int32
          description: Minimum quantity threshold
          example: 5
        maxQuantity:
          type: integer
          format: int32
          description: Maximum quantity threshold
          example: 20
        includeUsed:
          type: boolean
          description: Whether used inventory is included in stock calculations
        autoCreate:
          type: boolean
          description: Whether inventory orders are automatically created when stock is low
        active:
          type: boolean
          description: Whether this inventory level is active
        customerPoNumber:
          type: string
          description: >-
            Optional customer PO number copied to restock orders created from
            this level
          example: PO-12345
        stockDetails:
          $ref: '#/components/schemas/StockDetails'
          description: Current stock details for this inventory level
        createdInventoryOrderId:
          type: string
          format: uuid
          description: >-
            Inventory order id created by autoCreate; null when no restock was
            triggered.
          example: 123E4567-E89B-12D3-A456-426614174000
      required:
        - active
        - autoCreate
        - id
        - includeUsed
        - maxQuantity
        - minQuantity
        - skuId
        - stockDetails
        - warehouseId
    PublicApiHttpErrors:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/PublicApiError'
      required:
        - errors
    StockDetails:
      type: object
      description: Current stock availability details
      properties:
        newInventories:
          type: integer
          format: int32
          description: Count of new-condition inventory items available
          example: 12
        usedInventories:
          type: integer
          format: int32
          description: Count of used-condition inventory items available
          example: 3
        pendingInventoryOrders:
          type: integer
          format: int32
          description: Count of pending inventory order items
          example: 2
        totalAvailable:
          type: integer
          format: int32
          description: >-
            Total effective available stock (new + pending, plus used if
            includeUsed)
          example: 14
        totalItemsToOrder:
          type: integer
          format: int32
          description: Number of items to order to reach max level
          example: 6
      required:
        - newInventories
        - pendingInventoryOrders
        - totalAvailable
        - totalItemsToOrder
        - usedInventories
    PublicApiError:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable description of the error
          example: Invalid request
        source:
          type: string
          description: >-
            Entity or field path that caused the error (for example order,
            shipmentNotice, or person:email)
          example: request
      required:
        - detail
        - source
  securitySchemes:
    ApiKey:
      type: apiKey
      description: Prefix the value with "ApiKey" to indicate the custom authorization type
      name: Authorization
      in: header

````