Printago API
GET /v1/qr-tags/{id}

Get a QR tag

Requires any of: qr.scanqr.manage

Path Parameters

id required
string
QR tag ID

Response Schema

QrTag
batchIdrequirednullable
string
pattern: ^[a-z0-9]{24}$
boundAtrequirednullable
string
format: date-time
boundByrequirednullable
string
createdAtrequired
string
format: date-time
displaySnapshotrequirednullable
object
Caption data captured when a tag is created, so a tag still describes its target after the target is deleted.
brandoptional
string
codeoptional
string
The short code printed on a blank tag so two blanks can be told apart. It stays after the blank is set up, and becomes a new spool's label code.
coloroptionalnullable
string
#RRGGBBAA, or several joined with ";" for multicolor filament
materialNameoptional
string
Variant tags
nameoptional
string
The printer's name for printer and slot tags; the variant's name for variant and spool tags
provideroptionalnullable
string
slotRefoptional
string
Slot tags: the slot as the app names it, such as A1/3 or S1
entityIdrequirednullable
string
The printerId for printer_slot tags; null while blank. A blank keeps its printed payload (t: 'blank') after it is set up; this row says what it is.
pattern: ^[a-z0-9]{24}$
entityTyperequired
"blank" | "printer" | "printer_slot" | "material_variant" | "material_instance"
blankprinterprinter_slotmaterial_variantmaterial_instance
idrequired
string
pattern: ^[A-Za-z0-9_-]{1,24}$
labelrequirednullable
string
lastScannedAtrequirednullable
string
format: date-time
payloadVersionrequired
number
printedAtrequirednullable
string
format: date-time
revokedAtrequirednullable
string
format: date-time
revokedByrequirednullable
string
scanCountrequired
number
slotAmsIndexrequirednullable
number
Slot identity for printer_slot tags; amsIndex -1 is the external spool
slotSlotIndexrequirednullable
number
statusrequired
"blank" | "active" | "revoked" | "orphaned"
blankactiverevokedorphaned
storeIdrequired
string
pattern: ^[a-z0-9]{24}$
updatedAtrequired
string
format: date-time

Example Response

200 OK — application/json
{
  "id": "string",
  "status": "blank",
  "entityType": "blank",
  "entityId": "string",
  "slotAmsIndex": 1,
  "slotSlotIndex": 1,
  "label": "string",
  "batchId": "string",
  "payloadVersion": 1,
  "displaySnapshot": {
    "name": "string",
    "provider": "string",
    "slotRef": "string",
    "materialName": "string",
    "brand": "string",
    "color": "string",
    "code": "string"
  },
  "printedAt": "2025-01-15T12:00:00.000Z",
  "boundAt": "2025-01-15T12:00:00.000Z",
  "boundBy": "string",
  "revokedAt": "2025-01-15T12:00:00.000Z",
  "revokedBy": "string",
  "lastScannedAt": "2025-01-15T12:00:00.000Z",
  "scanCount": 1,
  "storeId": "string",
  "updatedAt": "2025-01-15T12:00:00.000Z",
  "createdAt": "2025-01-15T12:00:00.000Z"
}