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
| Name | In | Type | Required | Description |
|---|
positions | query | string | No | |
id | path | uuid | Yes | |
Responses
| Status | Description |
|---|
200 | Default Response |
400 | Default Response |
401 | Default Response |
403 | Default Response |
404 | Default Response |
409 | Default Response |
422 | Default Response |
500 | Default Response |
503 | Default Response |
200 response fields
| Field | Type | Required | Description |
|---|
slots | object[] | Yes | |
freshness | object | Yes | |
400 response fields
| Field | Type | Required | Description |
|---|
error | string | No | |
message | string | No | |
requestId | string | No | |
code | string | No | |
position | number | No | |
slots | object[] | No | |
reason | string | No | |
reevaluations | object[] | No | |
holdingJob | object | No | |
401 response fields
| Field | Type | Required | Description |
|---|
error | string | No | |
message | string | No | |
requestId | string | No | |
code | string | No | |
position | number | No | |
slots | object[] | No | |
reason | string | No | |
reevaluations | object[] | No | |
holdingJob | object | No | |
403 response fields
| Field | Type | Required | Description |
|---|
error | string | No | |
message | string | No | |
requestId | string | No | |
code | string | No | |
position | number | No | |
slots | object[] | No | |
reason | string | No | |
reevaluations | object[] | No | |
holdingJob | object | No | |
404 response fields
| Field | Type | Required | Description |
|---|
error | string | No | |
message | string | No | |
requestId | string | No | |
code | string | No | |
position | number | No | |
slots | object[] | No | |
reason | string | No | |
reevaluations | object[] | No | |
holdingJob | object | No | |
409 response fields
| Field | Type | Required | Description |
|---|
error | string | No | |
message | string | No | |
requestId | string | No | |
code | string | No | |
position | number | No | |
slots | object[] | No | |
reason | string | No | |
reevaluations | object[] | No | |
holdingJob | object | No | |
422 response fields
| Field | Type | Required | Description |
|---|
error | string | No | |
message | string | No | |
requestId | string | No | |
code | string | No | |
position | number | No | |
slots | object[] | No | |
reason | string | No | |
reevaluations | object[] | No | |
holdingJob | object | No | |
500 response fields
| Field | Type | Required | Description |
|---|
error | string | No | |
message | string | No | |
requestId | string | No | |
code | string | No | |
position | number | No | |
slots | object[] | No | |
reason | string | No | |
reevaluations | object[] | No | |
holdingJob | object | No | |
503 response fields
| Field | Type | Required | Description |
|---|
error | string | No | |
message | string | No | |
requestId | string | No | |
code | string | No | |
position | number | No | |
slots | object[] | No | |
reason | string | No | |
reevaluations | object[] | No | |
holdingJob | object | No | |
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"
}
}