QR Codes
Retrieve QR Code
GET
/
qr-codes
/
{id}
Retrieve QR Code
curl --request GET \
--url https://api.useqrkit.com/v1/qr-codes/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.useqrkit.com/v1/qr-codes/{id}"
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/{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))
}HttpResponse<String> response = Unirest.get("https://api.useqrkit.com/v1/qr-codes/{id}")
.header("Authorization", "Bearer <token>")
.asString();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",
"name": "<string>",
"short_code": "AB3D5",
"short_url": "https://scan.useqrkit.com/AB3D5",
"target": {
"type": "<string>",
"destination": "<string>"
},
"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": {
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"message": "<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.
Path Parameters
qr_… (dynamic) or sqr_… (static).
Response
The QR code
qr_… for dynamic, sqr_… for static.
Example:
"qr_123"
Example:
"qr_code"
Available options:
dynamic, static Available options:
url, text, email, sms, wifi, event, vcard Example:
"AB3D5"
null for static codes.
Example:
"https://scan.useqrkit.com/AB3D5"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Example:
"fld_12"
Example:
"https://img.useqrkit.com/qr-AB3D5-1717000000000.svg"
Example:
"/v1/qr-codes/qr_123/download"
null for static codes (no tracking).
UTM parameters (null unless set on a dynamic url code).
Show child attributes
Show child attributes
⌘I
Retrieve QR Code
curl --request GET \
--url https://api.useqrkit.com/v1/qr-codes/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.useqrkit.com/v1/qr-codes/{id}"
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/{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))
}HttpResponse<String> response = Unirest.get("https://api.useqrkit.com/v1/qr-codes/{id}")
.header("Authorization", "Bearer <token>")
.asString();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",
"name": "<string>",
"short_code": "AB3D5",
"short_url": "https://scan.useqrkit.com/AB3D5",
"target": {
"type": "<string>",
"destination": "<string>"
},
"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": {
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"message": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}
