API Endpoint Reference / Printers

Read saved and fresh reported state for all printer slots in one snapshot

Deprecated. Use List Printer material slots with their Filament assignments and observed filament in one snapshot (GET /v1/printers/{id}/material-slots) instead. This operation keeps working, and no removal date is set.

GET https://api.printhiv3d.com/v1/printers/{id}/filaments/state

Operation ID listPrinterFilamentStates. Requires the read API key scope.

Requires an organization API key with read scope or an authenticated organization session. Host credentials are rejected, including Host-bound wildcard keys. Legacy unbound wildcard keys are accepted.

Parameters

NameInTypeRequiredDescription
positionsquerystringNo
idpathuuidYes

Responses

StatusDescription
200Default Response
400Default Response
401Default Response
403Default Response
404Default Response
409Default Response
422Default Response
500Default Response
503Default Response

200 response fields

FieldTypeRequiredDescription
slotsobject[]Yes
freshnessobjectYes

400 response fields

FieldTypeRequiredDescription
errorstringNo
messagestringNo
requestIdstringNo
codestringNo
positionnumberNo
slotsobject[]No
reasonstringNo
reevaluationsobject[]No
holdingJobobjectNo

401 response fields

FieldTypeRequiredDescription
errorstringNo
messagestringNo
requestIdstringNo
codestringNo
positionnumberNo
slotsobject[]No
reasonstringNo
reevaluationsobject[]No
holdingJobobjectNo

403 response fields

FieldTypeRequiredDescription
errorstringNo
messagestringNo
requestIdstringNo
codestringNo
positionnumberNo
slotsobject[]No
reasonstringNo
reevaluationsobject[]No
holdingJobobjectNo

404 response fields

FieldTypeRequiredDescription
errorstringNo
messagestringNo
requestIdstringNo
codestringNo
positionnumberNo
slotsobject[]No
reasonstringNo
reevaluationsobject[]No
holdingJobobjectNo

409 response fields

FieldTypeRequiredDescription
errorstringNo
messagestringNo
requestIdstringNo
codestringNo
positionnumberNo
slotsobject[]No
reasonstringNo
reevaluationsobject[]No
holdingJobobjectNo

422 response fields

FieldTypeRequiredDescription
errorstringNo
messagestringNo
requestIdstringNo
codestringNo
positionnumberNo
slotsobject[]No
reasonstringNo
reevaluationsobject[]No
holdingJobobjectNo

500 response fields

FieldTypeRequiredDescription
errorstringNo
messagestringNo
requestIdstringNo
codestringNo
positionnumberNo
slotsobject[]No
reasonstringNo
reevaluationsobject[]No
holdingJobobjectNo

503 response fields

FieldTypeRequiredDescription
errorstringNo
messagestringNo
requestIdstringNo
codestringNo
positionnumberNo
slotsobject[]No
reasonstringNo
reevaluationsobject[]No
holdingJobobjectNo

Example 200 response

{
  "slots": [
    {
      "position": 0,
      "assignment": {
        "materialId": "9c2e7b4a-1d8f-4a63-8f5b-6e0d3a9c7b21",
        "materialType": "PLA",
        "color": "#FFFFFF",
        "filamentId": "GFA00",
        "settingId": "GFA00",
        "version": null,
        "assignmentRevision": "5f8a2c6e-9d1b-4e73-b4a0-2c7e9f1d6b85"
      },
      "observation": {
        "status": "observed",
        "observedAt": "2026-11-04T18:00:00.000Z",
        "reported": {
          "materialType": "PLA",
          "color": "#FFFFFF",
          "filamentId": "GFA00",
          "settingId": "GFA00"
        }
      }
    }
  ],
  "freshness": {
    "status": "fresh",
    "observedAt": "2026-11-04T18:00:00.000Z"
  }
}