Skip to content
LabelyardLabelyardLabelyard

Resolve an integration entity

GET
/api/v1/lookup/{app}/{entity_id}
curl --request GET \
  --url https://example.com/api/v1/lookup/snipeit/example \
  --header 'X-Label-Hub-Key: <X-Label-Hub-Key>'

Looks up an entity from the given integration app by its identifier. app must be one of snipeit, grocy, or spoolman — an unsupported value returns 422. Returns 404 ProblemDetail when the entity does not exist in the integration’s backend. The url field is the deep-link to the entity in the integration’s own web UI, suitable for embedding in a QR code or label.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
app
required
App
string
Allowed values: snipeit grocy spoolman
entity_id
required
Entity Id
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
LookupResult

REST view of a resolved integration entity.

object
app
required
App

Integration app that resolved this entity

string
Allowed values: snipeit grocy spoolman
extra
Extra

Integration-specific extras not covered by the core fields. Contents vary by app — see each integration’s plugin docs.

object
key
additional properties
any
id
required
Id

The entity identifier as supplied by the caller

string
name
Name

Human-readable display name of the entity

Any of:
string
url
Url

Deep-link URL to the entity in the integration’s web UI (e.g. Snipe-IT asset page, Grocy product page, Spoolman spool page)

Any of:
string

Example 

{
  "app": "snipeit"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}