Retrieve a QR code
curl --request GET \
--url https://biq.li/api/v1/qr/{qr} \
--header 'Authorization: Bearer <token>'import requests
url = "https://biq.li/api/v1/qr/{qr}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://biq.li/api/v1/qr/{qr}', 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://biq.li/api/v1/qr/{qr}",
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://biq.li/api/v1/qr/{qr}"
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://biq.li/api/v1/qr/{qr}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://biq.li/api/v1/qr/{qr}")
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{
"qr_code": {
"id": "<string>",
"type": "static",
"content_type": "text",
"title": "<string>",
"payload": {
"long_url": "<string>",
"text": "<string>",
"phone": "<string>",
"message": "<string>",
"ssid": "<string>",
"encryption": "none",
"password": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"organization": "<string>",
"fax": "<string>",
"email": "jsmith@example.com",
"subject": "<string>",
"website": "<string>",
"socials": {
"youtube": "<string>",
"x": "<string>",
"instagram": "<string>",
"tiktok": "<string>",
"linkedin": "<string>"
},
"title": "<string>",
"description": "<string>",
"location": "<string>",
"url": "<string>",
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"app_store_url": "<string>",
"google_play_url": "<string>",
"fallback_url": "<string>"
},
"scan_value": "<string>",
"qr_config": {
"matrixColor": "<string>",
"eyeFrameColor": "<string>",
"eyeColor": "<string>",
"matrixColorMode": "flat",
"matrixGradient": {
"colorOne": "#214687",
"colorTwo": "#44C8DE",
"angle": "0deg",
"midpoint": 50
},
"eyeFrameColorMode": "flat",
"eyeFrameGradient": {
"colorOne": "#214687",
"colorTwo": "#44C8DE",
"angle": "0deg",
"midpoint": 50
},
"eyeColorMode": "flat",
"eyeGradient": {
"colorOne": "#214687",
"colorTwo": "#44C8DE",
"angle": "0deg",
"midpoint": 50
},
"applyGradientToAll": true,
"applyEyeFrameGradientToEye": true,
"matrixStyle": "square",
"eyeFrameStyle": "square",
"eyeStyle": "square",
"showLogo": true
},
"geo_rules": [
{
"key": "<string>",
"value": "<string>"
}
],
"device_rules": [
{
"key": "<string>",
"value": "<string>"
}
],
"platform_rules": [
{
"key": "<string>",
"value": "<string>"
}
],
"tag_ids": [
"<string>"
],
"clicks_count": 1,
"safety_status": "clear",
"utm": "<string>",
"activates_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"exp_clicks_rule": {},
"clicked_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"status": "success"
}{
"error": {
"code": "invalid_token",
"message": "<string>",
"details": {}
},
"request_id": "<string>"
}{
"error": {
"code": "invalid_token",
"message": "<string>",
"details": {}
},
"request_id": "<string>"
}{
"error": {
"code": "invalid_token",
"message": "<string>",
"details": {}
},
"request_id": "<string>"
}{
"error": {
"code": "invalid_token",
"message": "<string>",
"details": {}
},
"request_id": "<string>"
}{
"error": {
"code": "invalid_token",
"message": "<string>",
"details": {}
},
"request_id": "<string>"
}QR codes
Retrieve a QR code
Retrieve one QR code’s complete public content, behavior, and design.
GET
/
v1
/
qr
/
{qr}
Retrieve a QR code
curl --request GET \
--url https://biq.li/api/v1/qr/{qr} \
--header 'Authorization: Bearer <token>'import requests
url = "https://biq.li/api/v1/qr/{qr}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://biq.li/api/v1/qr/{qr}', 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://biq.li/api/v1/qr/{qr}",
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://biq.li/api/v1/qr/{qr}"
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://biq.li/api/v1/qr/{qr}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://biq.li/api/v1/qr/{qr}")
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{
"qr_code": {
"id": "<string>",
"type": "static",
"content_type": "text",
"title": "<string>",
"payload": {
"long_url": "<string>",
"text": "<string>",
"phone": "<string>",
"message": "<string>",
"ssid": "<string>",
"encryption": "none",
"password": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"organization": "<string>",
"fax": "<string>",
"email": "jsmith@example.com",
"subject": "<string>",
"website": "<string>",
"socials": {
"youtube": "<string>",
"x": "<string>",
"instagram": "<string>",
"tiktok": "<string>",
"linkedin": "<string>"
},
"title": "<string>",
"description": "<string>",
"location": "<string>",
"url": "<string>",
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"app_store_url": "<string>",
"google_play_url": "<string>",
"fallback_url": "<string>"
},
"scan_value": "<string>",
"qr_config": {
"matrixColor": "<string>",
"eyeFrameColor": "<string>",
"eyeColor": "<string>",
"matrixColorMode": "flat",
"matrixGradient": {
"colorOne": "#214687",
"colorTwo": "#44C8DE",
"angle": "0deg",
"midpoint": 50
},
"eyeFrameColorMode": "flat",
"eyeFrameGradient": {
"colorOne": "#214687",
"colorTwo": "#44C8DE",
"angle": "0deg",
"midpoint": 50
},
"eyeColorMode": "flat",
"eyeGradient": {
"colorOne": "#214687",
"colorTwo": "#44C8DE",
"angle": "0deg",
"midpoint": 50
},
"applyGradientToAll": true,
"applyEyeFrameGradientToEye": true,
"matrixStyle": "square",
"eyeFrameStyle": "square",
"eyeStyle": "square",
"showLogo": true
},
"geo_rules": [
{
"key": "<string>",
"value": "<string>"
}
],
"device_rules": [
{
"key": "<string>",
"value": "<string>"
}
],
"platform_rules": [
{
"key": "<string>",
"value": "<string>"
}
],
"tag_ids": [
"<string>"
],
"clicks_count": 1,
"safety_status": "clear",
"utm": "<string>",
"activates_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"exp_clicks_rule": {},
"clicked_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"status": "success"
}{
"error": {
"code": "invalid_token",
"message": "<string>",
"details": {}
},
"request_id": "<string>"
}{
"error": {
"code": "invalid_token",
"message": "<string>",
"details": {}
},
"request_id": "<string>"
}{
"error": {
"code": "invalid_token",
"message": "<string>",
"details": {}
},
"request_id": "<string>"
}{
"error": {
"code": "invalid_token",
"message": "<string>",
"details": {}
},
"request_id": "<string>"
}{
"error": {
"code": "invalid_token",
"message": "<string>",
"details": {}
},
"request_id": "<string>"
}GET /v1/qr/{qr_id} requires QR codes: Read (qr_codes.view).
curl https://biq.li/api/v1/qr/biq_qr_01M19Q8W6R3M0AS7B4PK2H5XCY \
-H 'Authorization: Bearer biqli_your_workspace_api_key' \
-H 'Accept: application/json'
| Field | Meaning |
|---|---|
id | Stable public biq_qr_... identifier. |
type, content_type | Static/dynamic behavior and encoded content type. |
title, payload | Display title and normalized content fields. |
scan_value | Directly encoded static value or stable dynamic Biqli tracking URL. |
qr_config | Validated public styling fields. Custom logo URLs are not exposed. |
utm | Encoded UTM query string when supported. |
activates_at, expires_at | Dynamic schedule in ISO 8601 format. |
geo_rules, device_rules, platform_rules | Dynamic routing rules. |
exp_clicks_rule | Scan-count expiration rule or null. |
tag_ids | Attached workspace tag public IDs. |
clicks_count, clicked_at | Aggregate scan count and most recent scan time. |
safety_status | clear, pending, or quarantined. |
created_at, updated_at | ISO 8601 resource timestamps. |
404 resource_not_found.

