QR Codes

Restore QR Code

Restores a QR code from the Trash — or a dynamic code a plan downgrade paused — exactly as it was: same id, short URL, design, folder and scan history. A restored dynamic code is active again, so its redirect works for every copy already printed. No request body. Requires the qr:write scope. Emits qr.restored with the restored code as data.

Find restorable codes with GET /v1/qr-codes?status=trashed (or status=paused).

Plan limits. A dynamic code takes one of the plan’s QR code slots when restored, so the restore is refused with 422 and reason: PLAN_LIMIT (plus limit, current_count and plan_id) when the plan is full. A dynamic GS1 Digital Link code counts against the plan’s separate GS1 allowance instead (the error also carries gs1_code: PLAN_LIMIT), and needs a plan that includes the GS1 resolver (403, gs1_code: NOT_ENTITLED). Its identifier needs no check: a code in the Trash keeps holding it, so nobody else can have registered it meanwhile. Static codes have no limit. Free-plan API keys manage static codes only, so restoring a dynamic code with one is 403.

Concurrency. Restores, creates and re-activations through the API, and restores and re-activations in the dashboard, are serialized per workspace, so parallel requests cannot go past the plan’s limit — each one counts the slots the others already took. (A code created in the dashboard at the same moment is not part of that serialization.)

Not in the Trash. Two 409 conflict answers, which a client must tell apart by reason:

NOT_IN_TRASH — the code is live (is_active: true). There is nothing to restore; a client retrying a restore whose response it lost can treat this as success.
DEACTIVATED — the code was switched off (is_active: false) but never deleted. Not success: its redirect is still off. Re-activate it with PATCH and is_active: true.

An id that does not exist, or belongs to another workspace, is 404 — and so is GET /v1/qr-codes/{id} for a code in the Trash; find those with GET /v1/qr-codes?status=trashed.

Removed custom domain. A dynamic GS1 code whose custom domain has been removed (the hostname is gone for good) cannot be restored: 409 with reason: DOMAIN_RETIRED.

POST

qr-codes

{id}

restore

Restore QR Code

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

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

fetch('https://api.useqrkit.com/v1/qr-codes/{id}/restore', 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}/restore",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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}/restore"

	req, _ := http.NewRequest("POST", 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}/restore")

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

request = Net::HTTP::Post.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://qrkit.to/AB3D5",
  "domain_id": "dom_3",
  "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",
  "deleted_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "reason": "NOT_IN_TRASH",
    "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>",
    "reason": "NOT_IN_TRASH",
    "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>",
    "reason": "NOT_IN_TRASH",
    "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": "conflict",
    "message": "QR code is not in the Trash — only deleted codes can be restored.",
    "reason": "NOT_IN_TRASH",
    "doc_url": "https://docs.useqrkit.com/errors#conflict",
    "request_id": "req_abc123"
  }
}

{
  "error": {
    "code": "unprocessable_entity",
    "message": "QR code limit reached for your starter plan (12 QR codes). Delete or deactivate a dynamic code, or upgrade, to restore this one.",
    "reason": "PLAN_LIMIT",
    "limit": 12,
    "current_count": 12,
    "plan_id": "starter",
    "doc_url": "https://docs.useqrkit.com/errors#unprocessable_entity",
    "request_id": "req_abc123"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "reason": "NOT_IN_TRASH",
    "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_… or sqr_…, as returned while the code was live or by GET /v1/qr-codes?status=trashed.

Response

The restored QR code (deleted_at is null).

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

string

The stored type: any target.type the API creates (a review is stored as linkpage), gs1, or a dashboard-only type such as file, menupage, form or smarturl. Treat unknown values as opaque.

Example:

"url"

short_code

string

Example:

"AB3D5"

short_url

string | null

null for static codes. On the workspace custom domain when the code was created on one. For a dynamic GS1 code this is the Digital Link URI itself, not <host>/<short_code>.

Example:

"https://qrkit.to/AB3D5"

domain_id

string | null

The custom domain short_url is on, or null for the default host (and for static codes).

Example:

"dom_3"

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

Dynamic codes: whether the redirect is on. Static codes: false while the code is in the Trash (the printed payload itself keeps working).

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>

deleted_at

string<date-time> | null

null for a live code. Set while the code is in the Trash (or paused by a plan downgrade); restore it with POST /v1/qr-codes/{id}/restore.

Restore QR Code

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

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

fetch('https://api.useqrkit.com/v1/qr-codes/{id}/restore', 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}/restore",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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}/restore"

	req, _ := http.NewRequest("POST", 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}/restore")

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

request = Net::HTTP::Post.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://qrkit.to/AB3D5",
  "domain_id": "dom_3",
  "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",
  "deleted_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "reason": "NOT_IN_TRASH",
    "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>",
    "reason": "NOT_IN_TRASH",
    "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>",
    "reason": "NOT_IN_TRASH",
    "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": "conflict",
    "message": "QR code is not in the Trash — only deleted codes can be restored.",
    "reason": "NOT_IN_TRASH",
    "doc_url": "https://docs.useqrkit.com/errors#conflict",
    "request_id": "req_abc123"
  }
}

{
  "error": {
    "code": "unprocessable_entity",
    "message": "QR code limit reached for your starter plan (12 QR codes). Delete or deactivate a dynamic code, or upgrade, to restore this one.",
    "reason": "PLAN_LIMIT",
    "limit": 12,
    "current_count": 12,
    "plan_id": "starter",
    "doc_url": "https://docs.useqrkit.com/errors#unprocessable_entity",
    "request_id": "req_abc123"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "reason": "NOT_IN_TRASH",
    "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

Account

QR Codes

Batches

Folders

Tokens

Account

QR Codes

Batches

Folders

Tokens

Webhooks

Events

Restore QR Code

Authorizations

Path Parameters

Response