QR Codes

GS1 Linkset

The RFC 9264 linkset for a dynamic GS1 Digital Link code: every link the resolver would serve for this identifier, with one anchor per lot/serial override. Requires the qr:read scope.

Returned as application/linkset+json without this API’s { data } envelope, and with a Link header pointing at the GS1 JSON-LD context — the bytes are the same ones QRKit’s resolver serves, so you can hand them straight to a validator or stand the record up on your own resolver. Link relations are full GS1 vocabulary IRIs.

Every anchor carries the links registered ON it plus everything inherited from the level above (section 2.5.10): an override for 10/LOT1 publishes the GTIN’s links as well as its own, most general first, with a repeated href listed once per relation. The default link is published twice — under gs1:defaultLink, and under the descriptive gs1:pip relation a client can ask for by name. Non-https destinations are dropped rather than served.

Static GS1 codes resolve on your own host and QRKit holds no link record for them, so they return 422; so does a non-GS1 code.

GET

qr-codes

{id}

linkset

GS1 Linkset

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

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

fetch('https://api.useqrkit.com/v1/qr-codes/{id}/linkset', 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}/linkset",
  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}/linkset"

	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}/linkset")

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

{
  "linkset": [
    {
      "anchor": "https://qrkit.to/01/09506000134352",
      "https://ref.gs1.org/voc/pip": [
        {
          "href": "https://brand.example/products/cocoa-200g",
          "title": "Product information",
          "hreflang": [
            "en"
          ]
        }
      ],
      "https://ref.gs1.org/voc/defaultLink": [
        {
          "href": "https://brand.example/products/cocoa-200g",
          "title": "Cocoa 200g"
        }
      ]
    },
    {
      "anchor": "https://qrkit.to/01/09506000134352/10/LOT1",
      "https://ref.gs1.org/voc/pip": [
        {
          "href": "https://brand.example/products/cocoa-200g",
          "title": "Product information",
          "hreflang": [
            "en"
          ]
        },
        {
          "href": "https://brand.example/recalls/2026-07",
          "title": "Cocoa 200g"
        }
      ],
      "https://ref.gs1.org/voc/defaultLink": [
        {
          "href": "https://brand.example/recalls/2026-07",
          "title": "Cocoa 200g"
        }
      ]
    }
  ]
}

{
  "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>"
  }
}

{
  "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_… — a dynamic GS1 code.

Response

The linkset

An RFC 9264 linkset. Link relations are FULL GS1 vocabulary IRIs (https://ref.gs1.org/voc/pip), never gs1: CURIEs — the published linkset schema rejects a colon in a key. Each override gets its OWN anchor: a lot-specific recall belongs to that lot's URI, not to every unit ever made — and that anchor also carries everything registered on the level above it (section 2.5.10). These are the same bytes QRKit's resolver serves for the same identifier.

linkset

object[]

Show child attributes

GS1 Linkset

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

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

fetch('https://api.useqrkit.com/v1/qr-codes/{id}/linkset', 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}/linkset",
  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}/linkset"

	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}/linkset")

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

{
  "linkset": [
    {
      "anchor": "https://qrkit.to/01/09506000134352",
      "https://ref.gs1.org/voc/pip": [
        {
          "href": "https://brand.example/products/cocoa-200g",
          "title": "Product information",
          "hreflang": [
            "en"
          ]
        }
      ],
      "https://ref.gs1.org/voc/defaultLink": [
        {
          "href": "https://brand.example/products/cocoa-200g",
          "title": "Cocoa 200g"
        }
      ]
    },
    {
      "anchor": "https://qrkit.to/01/09506000134352/10/LOT1",
      "https://ref.gs1.org/voc/pip": [
        {
          "href": "https://brand.example/products/cocoa-200g",
          "title": "Product information",
          "hreflang": [
            "en"
          ]
        },
        {
          "href": "https://brand.example/recalls/2026-07",
          "title": "Cocoa 200g"
        }
      ],
      "https://ref.gs1.org/voc/defaultLink": [
        {
          "href": "https://brand.example/recalls/2026-07",
          "title": "Cocoa 200g"
        }
      ]
    }
  ]
}

{
  "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>"
  }
}

{
  "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

GS1 Linkset

Authorizations

Path Parameters

Response