QR Codes
List QR Codes
Lists dynamic and static QR codes in the workspace (newest first by
default), with cursor pagination. Requires the qr:read scope.
Each code’s target.editable says whether it can be re-pointed through
PATCH /v1/qr-codes/{id}; dashboard-authored codes report false and
carry their public hosted page URL in target.destination.
GET
/
qr-codes
List QR Codes
curl --request GET \
--url https://api.useqrkit.com/v1/qr-codes \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.useqrkit.com/v1/qr-codes"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.useqrkit.com/v1/qr-codes', 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",
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"
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))
}HttpResponse<String> response = Unirest.get("https://api.useqrkit.com/v1/qr-codes")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useqrkit.com/v1/qr-codes")
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{
"object": "list",
"has_more": true,
"next_cursor": "<string>",
"data": [
{
"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
API key in the Authorization header: Bearer qr_live_… or Bearer qr_test_…. Token endpoints take a Clerk session JWT instead.
Query Parameters
Required range:
1 <= x <= 100Opaque cursor from a previous response's next_cursor.
Available options:
dynamic, static, all Only codes in this folder (e.g. fld_12).
inactive only matches paused dynamic codes.
Available options:
active, inactive, all Available options:
created_at, updated_at, name, scan_count Available options:
asc, desc Case-insensitive name search.
⌘I
List QR Codes
curl --request GET \
--url https://api.useqrkit.com/v1/qr-codes \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.useqrkit.com/v1/qr-codes"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.useqrkit.com/v1/qr-codes', 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",
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"
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))
}HttpResponse<String> response = Unirest.get("https://api.useqrkit.com/v1/qr-codes")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useqrkit.com/v1/qr-codes")
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{
"object": "list",
"has_more": true,
"next_cursor": "<string>",
"data": [
{
"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>"
}
}
