Skip to main content
GET
/
materials
/
components
List component inventory
curl --request GET \
  --url https://api.autoprintfarm.com/public/v1/materials/components \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "type": "<string>",
      "name": "<string>",
      "color": "<string>",
      "brand": "<string>",
      "diameter": "<string>",
      "size": "<string>",
      "remaining_units": 123,
      "low_threshold": 123,
      "status": "<string>",
      "location": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ]
}

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 remaining_units is at or below low_threshold

Available options:
true,
false

Response

Component inventory list

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