QR Codes

Retrieve QR Code

Retrieve one QR code by id.

target.editable tells you whether the code can be re-pointed through PATCH /v1/qr-codes/{id}. Codes authored in the QRKit dashboard — link pages, forms, menus, app-store and smart-URL codes, and uploaded file/audio/video codes — report editable: false; their target.destination is the public hosted page URL (the same value as short_url) rather than the stored document or file key, and linkpage, form and menupage additionally carry a small target.summary.

GET

qr-codes

{id}

Retrieve QR Code

curl --request GET \
  --url https://api.useqrkit.com/v1/qr-codes/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.useqrkit.com/v1/qr-codes/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.useqrkit.com/v1/qr-codes/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.useqrkit.com/v1/qr-codes/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.useqrkit.com/v1/qr-codes/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "qr_123",
  "object": "qr_code",
  "kind": "dynamic",
  "name": "<string>",
  "type": "url",
  "short_code": "AB3D5",
  "short_url": "https://scan.useqrkit.com/AB3D5",
  "gs1": {
    "mode": "static",
    "key": "01/09506000134352/10/LOT1",
    "digital_link": "<string>",
    "primary_key": {
      "ai": "<string>",
      "value": "<string>"
    },
    "qualifiers": [
      {
        "ai": "<string>",
        "value": "<string>"
      }
    ],
    "attributes": {},
    "links": [
      {
        "linkType": "gs1:pip",
        "href": "<string>",
        "title": "<string>",
        "hreflang": [
          "<string>"
        ],
        "type": "<string>",
        "context": [
          "<string>"
        ]
      }
    ],
    "overrides": [
      {
        "path": "10/LOT1",
        "href": "<string>",
        "links": [
          {
            "linkType": "gs1:pip",
            "href": "<string>",
            "title": "<string>",
            "hreflang": [
              "<string>"
            ],
            "type": "<string>",
            "context": [
              "<string>"
            ]
          }
        ]
      }
    ],
    "linkset_url": "https://api.useqrkit.com/v1/qr-codes/qr_123/linkset"
  },
  "target": {
    "type": "<string>",
    "destination": "<string>",
    "editable": true,
    "summary": {
      "title": "<string>",
      "menus": 123,
      "items": 123
    }
  },
  "design": {
    "colors": {
      "foreground": "<string>",
      "background": "<string>"
    },
    "gradient": {
      "start": "<string>",
      "end": "<string>",
      "type": "<string>"
    },
    "shapes": {
      "body": "<string>",
      "eye_frame": "<string>",
      "eye_ball": "<string>"
    },
    "eye_colors": {
      "frame": "<string>",
      "ball": "<string>"
    },
    "has_logo": true,
    "transparent_background": true
  },
  "folder_id": "fld_12",
  "tags": [
    "<string>"
  ],
  "image_url": "https://img.useqrkit.com/qr-AB3D5-1717000000000.svg",
  "download_url": "/v1/qr-codes/qr_123/download",
  "is_active": true,
  "scan_count": 123,
  "utm": {
    "source": "<string>",
    "medium": "<string>",
    "campaign": "<string>",
    "term": "<string>",
    "content": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "gs1_code": "NOT_ENTITLED",
    "field": "<string>",
    "fields": [
      "<string>"
    ],
    "limit": 123,
    "current_count": 123,
    "requested": 123,
    "plan_id": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "gs1_code": "NOT_ENTITLED",
    "field": "<string>",
    "fields": [
      "<string>"
    ],
    "limit": 123,
    "current_count": 123,
    "requested": 123,
    "plan_id": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "gs1_code": "NOT_ENTITLED",
    "field": "<string>",
    "fields": [
      "<string>"
    ],
    "limit": 123,
    "current_count": 123,
    "requested": 123,
    "plan_id": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

Authorizations

Authorization

string

header

required

API key in the Authorization header: Bearer qr_live_… or Bearer qr_test_…. Token endpoints take a Clerk session JWT instead.

Path Parameters

string

required

qr_… (dynamic) or sqr_… (static).

Response

The QR code

string

qr_… for dynamic, sqr_… for static.

Example:

"qr_123"

object

string

Example:

"qr_code"

kind

enum<string>

Available options:

dynamic,

static

name

string

type

enum<string>

Available options:

url,

text,

email,

sms,

wifi,

event,

vcard,

gs1

short_code

string

Example:

"AB3D5"

short_url

string | null

null for static codes. For a dynamic GS1 code this is the Digital Link URI itself, not <host>/<short_code>.

Example:

"https://scan.useqrkit.com/AB3D5"

gs1

object

Present on GS1 codes only. The identifier half is READ-ONLY (R4 — it is printed); links and overrides are the editable half.

Show child attributes

target

object

Show child attributes

design

object | null

Show child attributes

folder_id

string | null

Example:

"fld_12"

tags

string[]

image_url

string

Example:

"https://img.useqrkit.com/qr-AB3D5-1717000000000.svg"

download_url

string

Example:

"/v1/qr-codes/qr_123/download"

is_active

boolean

scan_count

integer | null

null for static codes (no tracking).

utm

object | null

UTM parameters (null unless set on a dynamic url code).

Show child attributes

created_at

string<date-time>

updated_at

string<date-time>

Retrieve QR Code

curl --request GET \
  --url https://api.useqrkit.com/v1/qr-codes/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.useqrkit.com/v1/qr-codes/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.useqrkit.com/v1/qr-codes/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.useqrkit.com/v1/qr-codes/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.useqrkit.com/v1/qr-codes/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "qr_123",
  "object": "qr_code",
  "kind": "dynamic",
  "name": "<string>",
  "type": "url",
  "short_code": "AB3D5",
  "short_url": "https://scan.useqrkit.com/AB3D5",
  "gs1": {
    "mode": "static",
    "key": "01/09506000134352/10/LOT1",
    "digital_link": "<string>",
    "primary_key": {
      "ai": "<string>",
      "value": "<string>"
    },
    "qualifiers": [
      {
        "ai": "<string>",
        "value": "<string>"
      }
    ],
    "attributes": {},
    "links": [
      {
        "linkType": "gs1:pip",
        "href": "<string>",
        "title": "<string>",
        "hreflang": [
          "<string>"
        ],
        "type": "<string>",
        "context": [
          "<string>"
        ]
      }
    ],
    "overrides": [
      {
        "path": "10/LOT1",
        "href": "<string>",
        "links": [
          {
            "linkType": "gs1:pip",
            "href": "<string>",
            "title": "<string>",
            "hreflang": [
              "<string>"
            ],
            "type": "<string>",
            "context": [
              "<string>"
            ]
          }
        ]
      }
    ],
    "linkset_url": "https://api.useqrkit.com/v1/qr-codes/qr_123/linkset"
  },
  "target": {
    "type": "<string>",
    "destination": "<string>",
    "editable": true,
    "summary": {
      "title": "<string>",
      "menus": 123,
      "items": 123
    }
  },
  "design": {
    "colors": {
      "foreground": "<string>",
      "background": "<string>"
    },
    "gradient": {
      "start": "<string>",
      "end": "<string>",
      "type": "<string>"
    },
    "shapes": {
      "body": "<string>",
      "eye_frame": "<string>",
      "eye_ball": "<string>"
    },
    "eye_colors": {
      "frame": "<string>",
      "ball": "<string>"
    },
    "has_logo": true,
    "transparent_background": true
  },
  "folder_id": "fld_12",
  "tags": [
    "<string>"
  ],
  "image_url": "https://img.useqrkit.com/qr-AB3D5-1717000000000.svg",
  "download_url": "/v1/qr-codes/qr_123/download",
  "is_active": true,
  "scan_count": 123,
  "utm": {
    "source": "<string>",
    "medium": "<string>",
    "campaign": "<string>",
    "term": "<string>",
    "content": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "gs1_code": "NOT_ENTITLED",
    "field": "<string>",
    "fields": [
      "<string>"
    ],
    "limit": 123,
    "current_count": 123,
    "requested": 123,
    "plan_id": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "gs1_code": "NOT_ENTITLED",
    "field": "<string>",
    "fields": [
      "<string>"
    ],
    "limit": 123,
    "current_count": 123,
    "requested": 123,
    "plan_id": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "gs1_code": "NOT_ENTITLED",
    "field": "<string>",
    "fields": [
      "<string>"
    ],
    "limit": 123,
    "current_count": 123,
    "requested": 123,
    "plan_id": "<string>",
    "doc_url": "<string>",
    "request_id": "<string>"
  }
}

Overview

QR Codes

Batches

Folders

Tokens

Account

QR Codes

Batches

Folders

Tokens

Webhooks

Events

Retrieve QR Code

Authorizations

Path Parameters

Response