API Endpoint Reference / Printers

Read an organization printer and loaded filament

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

Operation ID getPrinter. Requires the read API key scope.

Parameters

NameInTypeRequiredDescription
idpathuuidYes

Responses

StatusDescription
200Default Response

200 response fields

FieldTypeRequiredDescription
iduuidYes
namestringYes
makestringYes
modelstringYes
modelIdnull | stringYes
familystringYes
nozzleDiameternull | numberYes
buildPlatenull | stringYes
connectednull | booleanYes
readyMarkedbooleanYes
readinessobjectYes
maintenancebooleanYes
state"idle" | "printing" | "paused" | "offline" | "maintenance" | "ready-marked" | "unknown"Yes
loadedFilamentobject[]Yes

Example 200 response

{
  "id": "7d3f1c2a-5b8e-4f6a-9c1d-2e4b6a8c0f13",
  "name": "Bay 3",
  "make": "Bambu Lab",
  "model": "P1S",
  "modelId": "bambu-p1s",
  "family": "P1",
  "nozzleDiameter": 0.4,
  "buildPlate": "Textured PEI Plate",
  "connected": true,
  "readyMarked": true,
  "readiness": {
    "ready": true,
    "bedClear": true
  },
  "maintenance": false,
  "state": "idle",
  "loadedFilament": [
    {
      "slot": "AMS 1 slot 1",
      "position": 0,
      "address": {
        "ams_id": 0,
        "slot_id": 0
      },
      "state": "loaded",
      "material": "PLA",
      "color": "Jade White",
      "colorHex": "#FFFFFF"
    }
  ]
}