Get QR code

GET

/api/sites/{id}/qr-codes/{qrID}

curl --request GET \
  --url https://app.hitkeep.com/api/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/qr-codes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --cookie hk_token=<hk_token>

Returns one saved QR campaign definition. Requires site.view.

Authorizations

• cookieAuth
• bearerAuth
• apiKeyAuth

Parameters

Path Parameters

id

required

string format: uuid

qrID

required

string format: uuid

Responses

200

QR code

Media type application/json

object

archived_at

string format: date-time

created_at

string format: date-time

created_by

string format: uuid

custom_params

object

key

additional properties

string

destination_url

string format: uri

has_asset

boolean

id

string format: uuid

name

string

redirect_url

Dynamic HitKeep redirect URL to encode in printed QR assets.

string format: uri

site_id

string format: uuid

style

object

key

additional properties

any

token_hint

string

updated_at

string format: date-time

utm_campaign

string

utm_content

string

utm_medium

string

utm_source

string

utm_term

string

Example ^generated

{
  "archived_at": "2026-04-15T12:00:00Z",
  "created_at": "2026-04-15T12:00:00Z",
  "created_by": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "custom_params": {
    "additionalProperty": "example"
  },
  "destination_url": "https://example.com",
  "has_asset": true,
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "redirect_url": "https://example.com",
  "site_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "style": {},
  "token_hint": "example",
  "updated_at": "2026-04-15T12:00:00Z",
  "utm_campaign": "example",
  "utm_content": "example",
  "utm_medium": "example",
  "utm_source": "example",
  "utm_term": "example"
}

404

Not found

Media type application/json

object

message

string

Example ^generated

{
  "message": "example"
}