Open Inventory / Docs
EndpointsLabel printingLabel workspace

Read the personal saved print list

The API runs on your application instance. Schemas and field names come directly from the OpenAPI specification. Session-authenticated requests require a session on that instance.

GET
/label-workspace

Requires a user browser session with labels.read. Data is scoped to the current user and organization.

Authorization

adminSession
cookieauthjs.session-token<token>

Authenticated Auth.js browser session cookie; each operation declares its required permission. Not restricted to administrators. HTTPS deployments use the secure-prefixed cookie variant.

Header Parameters

X-Organization-ID?string

Organization membership selected for this request. User-bound credentials may select any active membership; standalone tokens may only repeat their pinned organization ID.

Formatuuid

Response Body

Saved queue and preferences.

application/json
  1. response
revision*integer
Range0 <= value
labels*array<>
preferences*
Example Request
curl -X GET 'https://inventory.example.com/api/v1/label-workspace'
Example Response
{  "revision": 0,  "labels": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "template": "string",      "tape": 3.5,      "widthMm": 1,      "data": "string",      "preview": "string",      "resource": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "name": "string",        "subtitle": "string",        "sku": "string",        "barcode": "string",        "location": "string",        "type": "string",        "quantity": 0,        "cover": {          "url": "string",          "altText": "string"        },        "stockUnit": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "code": "string",          "location": "string"        }      },      "original": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "name": "string",        "subtitle": "string",        "sku": "string",        "barcode": "string",        "location": "string",        "type": "string",        "quantity": 0,        "cover": {          "url": "string",          "altText": "string"        },        "stockUnit": {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "code": "string",          "location": "string"        }      },      "setup": {        "name": "string",        "widthMm": 1,        "heightMm": 1,        "elements": [          {            "type": "text",            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "x": 0,            "y": 0,            "width": 1,            "height": 1,            "visible": true,            "layer": 0,            "autoWidth": true,            "fontSizeMm": 1,            "minFontSizeMm": 1,            "fontFamily": "sans",            "fontWeight": 100,            "letterSpacingEm": -0.1,            "lineHeight": 0.8,            "align": "left",            "verticalAlign": "top",            "textOverflow": "ellipsis",            "content": [              {                "text": "string",                "weight": 100,                "italic": true,                "underline": true              }            ]          }        ],        "inverted": true,        "id": "string",        "revision": 1,        "createdAt": "string",        "updatedAt": "string"      }    }  ],  "preferences": {    "setupId": "string",    "printTarget": "browser",    "tape": 3.5,    "printer": "string",    "sharedPrinter": "4cc1e6ff-2402-49c3-9b26-22ccf194a23b"  }}

Provision a shared Office printer POST

Requires a browser session with tokens.manage. Currently provisions 24 mm tape only. The returned iprt_ token is shown once and is restricted to this printer; store it in the agent configuration.

Save print preferences or replace the prepared list PATCH

Requires a user browser session with labels.read. Queue updates require the current revision; 409 prevents a stale browser from overwriting another window. At most 100 labels, one tape width and a 24 MiB JSON body. Preference updates merge only supplied keys.