Open Inventory / Docs
EndpointsLabel setupsLabel setupsId

Retrieve a label setup

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-setups/{id}

Requires labels.read (read scope for standalone tokens).

Authorization

bearerAuth
headerAuthorizationBearer <inv_ token>

Path Parameters

id*string

Label setup identifier.

Formatuuid

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

Label setup

application/json
  1. response
labelSetup*
Example Request
curl -X GET 'https://inventory.example.com/api/v1/label-setups/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "labelSetup": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "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          }        ]      }    ],    "revision": 1,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "inverted": true  }}