Skip to main content
GET
List finished-goods inventory

Authorizations

Authorization
string
header
required

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.

Query Parameters

low_stock
enum<string>

When true, returns only items where ready_stock is at or below low_stock_threshold (items with a null threshold are excluded). When false, returns the inverse.

Available options:
true,
false
sku
string

Filter by exact SKU code (case-sensitive).

material
string

Filter by exact material (case-sensitive, e.g. PLA, PETG).

status
enum<string>

Filter by stored status (computed at write-time from ready_stock, low_stock_threshold, and quantity_needs_assembly).

Available options:
in_stock,
low_stock,
out_of_stock,
needs_assembly
limit
integer

Opt-in pagination: max rows to return (1-500). Omit limit and offset to return the full result set (default). Supplying either enables pagination and adds a meta block to the response.

Required range: 1 <= x <= 500
offset
integer | null

Number of rows to skip for pagination (requires limit for a stable page).

Required range: x >= 0

Response

Inventory list

success
enum<boolean>
required
Available options:
true
data
object[]
required
meta
object

Present only when pagination (limit/offset) is requested.