QrCode

A request or response body; the type column links to the schemas it refers to.

QrCode

FieldTypeRequiredDescription
idstring (uuid)yes—
organization_idstring (uuid)yes—
owner_department_idstring (uuid) | nullyes

Owning department within the organization; null = owned by the organization directly. Scopes which qr-codes:read/write grants cover the code and, for a url code, who may follow it: every member for an organization-owned code, the owning department's role holders for a department-owned one.

slugstringyes—
namestringyes

What the code is for, as administrators see it; never shown to scanners.

descriptionstring | nullyes

Where the code is posted, or any other note for administrators.

targetQrCodeTargetyes—
created_bystring | nullyes—
created_atstring (date-time)yes—
updated_atstring (date-time)yes—
archived_atstring (date-time) | nullyes

An archived code answers unavailable to every scan; its history stays.

jsonExample
{
  "id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "organization_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "owner_department_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "slug": "bay-3-fume-hood",
  "name": "string",
  "description": "string",
  "target": {
    "kind": "job_aid",
    "id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
    "url": "https://example.com/safety-notice",
    "label": "string",
    "status": "live"
  },
  "created_by": "string",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "archived_at": "2026-01-01T00:00:00.000Z"
}