Skip to main content
GET
/
materials
/
filament
List filament inventory
curl --request GET \
  --url https://api.autoprintfarm.com/public/v1/materials/filament \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "type": "<string>",
      "color": "<string>",
      "hex_code": "<string>",
      "brand": "<string>",
      "diameter": "<string>",
      "remaining_grams": 123,
      "spool_weight_grams": 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 spools where remaining_grams is at or below low_threshold

Available options:
true,
false
​
material_type
string

Filter by exact filament type (e.g. PLA, PETG, ABS)

​
color
string

Filter by exact color label

Response

Filament inventory list

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