{"openapi":"3.1.0","info":{"title":"QR Code API","description":"This page contains the documentation on how to use the QR Code API through API calls.\n\n## API v2 versus API v1\n\nIt is recommended to use the v2 API for all new projects. \n\nHowever, not all endpoints are already available in v2.\n\nTherefore, if you need endpoints that are not available yet please use the v1 version for that area in the meantime.\n\nExamples of areas that are not yet in the v2 API:\n- GS1 QR codes\n- Custom variables\n\nYou can find the v1 API docs in the QR Code Portal in the menu `API`.\n\n## Authentication\n\n- All but the `/api/v2/health` endpoint require authentication. \n- To become authenticated you will need to use either a `public`, or `secret` token. \n- You find those tokens when you click on the `API` menu in the QR Code [Portal](https://qrplanet.com/user/login?r=/user/api) \n- The `secret` API key can be used for every endpoint. Use it only in server-to-server communication.\n- The `public` API key can usually only be used for reading endpoints (GET). It should be used for asynchronous GET requests in the browser (client-server communication via Javascript).\n\nExample to list your QR Codes (secret and public key can be used):\n```bash\ncurl -X 'GET' \\\n 'https://api.qrplanet.com/api/v2/qrcodes?type=URL&page=1&size=50' \\\n -H 'accept: application/json' \\\n -H 'Authorization: Bearer public:YOURDOMAIN.COM:XXXXXXX:YYYYYYY'\n```\n\nExample to create a QR Code (only secret key can be used):\n```bash\ncurl -X 'POST' \\\n 'https://api.qrplanet.com/api/v2/qrcodes' \\\n -H 'accept: application/json' \\\n -H 'Authorization: Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"target_url\": \"https://test.de\",\n \"slug\": \"easter-promotion-2\"\n}'\n```\n\nExample to download a Designer QR Code image with a multicolor template:\n```bash\ncurl -X 'POST' \\\n 'https://api.qrplanet.com/api/v2/qrcodes/easter-promotion-2/download-image/designer?designer_template_id=369cf5e76d8fcd34621860c332047877&format=PNG' \\ \n -H 'Authorization: Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY'\n```\n\n## Code Samples\n\nYou can find code samples for the endpoints for a couple of programming languages (`Python`, `PHP`, `Go`) as well as a `cURL` statement. If your programming language is not listed you can usually easily use a tool like `ChatGPT` or `Google Gemini` to convert the `cURL` example to your programming language of choice as a starting point.\n\n","version":"2.0.0"},"paths":{"/api/v2/qrcodes":{"get":{"tags":["QR Codes"],"summary":"List QR Codes","description":"Returns a paginated list of **QR codes** in your account.\n\n**Use this endpoint to:**\n- List dynamic or static QR codes\n- Filter by type/subtype (URL, WIFI, TEXT, etc.)\n- Filter by title/description/tags/folders\n- Filter by scan count and date ranges\n\n**Pagination:** uses `page` and `size`.","operationId":"list_qr_codes","security":[{"HTTPBearer":[]}],"parameters":[{"name":"type","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/QRCodeType"},{"type":"null"}],"description":"Filter by QR code type (exact match) *- example: URL*","title":"Type"},"description":"Filter by QR code type (exact match) *- example: URL*"},{"name":"subtype","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/QRCodeSubType"},{"type":"null"}],"description":"Filter by QR code subtype (exact match) *- example: QRCodeSubType.URL*","title":"Subtype"},"description":"Filter by QR code subtype (exact match) *- example: QRCodeSubType.URL*"},{"name":"code_like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by QR code code (partial match) *- example: easter-promotion-2*","title":"Code Like"},"description":"Filter by QR code code (partial match) *- example: easter-promotion-2*"},{"name":"medium","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by medium (exact match) *- example: FLYER*","title":"Medium"},"description":"Filter by medium (exact match) *- example: FLYER*"},{"name":"folder","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by folder (exact match) *- example: folder1*","title":"Folder"},"description":"Filter by folder (exact match) *- example: folder1*"},{"name":"tag","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by tag (exact match) *- example: tag1*","title":"Tag"},"description":"Filter by tag (exact match) *- example: tag1*"},{"name":"title","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by title (exact match) *- example: Easter Promotion 2 2025*","title":"Title"},"description":"Filter by title (exact match) *- example: Easter Promotion 2 2025*"},{"name":"title_like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by title (partial match) *- example: Easter Promotion*","title":"Title Like"},"description":"Filter by title (partial match) *- example: Easter Promotion*"},{"name":"description","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by description (exact match) *- example: Welcome to our Easter Promotion Relaunch 2025*","title":"Description"},"description":"Filter by description (exact match) *- example: Welcome to our Easter Promotion Relaunch 2025*"},{"name":"description_like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by description (partial match) *- example: Promotion Relaunch*","title":"Description Like"},"description":"Filter by description (partial match) *- example: Promotion Relaunch*"},{"name":"target_url","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by target url (exact match) *- example: https://test.de*","title":"Target Url"},"description":"Filter by target url (exact match) *- example: https://test.de*"},{"name":"target_url_like","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by target url (partial match) *- example: test.de*","title":"Target Url Like"},"description":"Filter by target url (partial match) *- example: test.de*"},{"name":"scan_count_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter number of scans of the QR code from this value (inclusive) *- example: 100*","title":"Scan Count From"},"description":"Filter number of scans of the QR code from this value (inclusive) *- example: 100*"},{"name":"scan_count_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter number of scans of the QR code up to this value (inclusive) *- example: 200*","title":"Scan Count To"},"description":"Filter number of scans of the QR code up to this value (inclusive) *- example: 200*"},{"name":"unique_visitor_count_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter number of unique visitors of the QR code from this value (inclusive) *- example: 50*","title":"Unique Visitor Count From"},"description":"Filter number of unique visitors of the QR code from this value (inclusive) *- example: 50*"},{"name":"unique_visitor_count_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter number of unique visitors of the QR code up to this value (inclusive) *- example: 100*","title":"Unique Visitor Count To"},"description":"Filter number of unique visitors of the QR code up to this value (inclusive) *- example: 100*"},{"name":"notify_email","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter if the notification for emails is active *- example: true*","title":"Notify Email"},"description":"Filter if the notification for emails is active *- example: true*"},{"name":"notify_sms","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Filter if the notification for emails is active *- example: true*","title":"Notify Sms"},"description":"Filter if the notification for emails is active *- example: true*"},{"name":"creation_at_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter creation date of QR code from this datetime (inclusive) *- example: 2025-09-27 00:00:01*","title":"Creation At From"},"description":"Filter creation date of QR code from this datetime (inclusive) *- example: 2025-09-27 00:00:01*"},{"name":"creation_at_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter creation date of QR code up to this datetime (inclusive) *- example: 2025-09-27 23:59:59*","title":"Creation At To"},"description":"Filter creation date of QR code up to this datetime (inclusive) *- example: 2025-09-27 23:59:59*"},{"name":"last_edit_at_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter last edit of QR code from this datetime (inclusive) *- example: 2025-09-27 00:00:01*","title":"Last Edit At From"},"description":"Filter last edit of QR code from this datetime (inclusive) *- example: 2025-09-27 00:00:01*"},{"name":"last_edit_at_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter last edit of QR code up to this datetime (inclusive) *- example: 2025-09-27 23:59:59*","title":"Last Edit At To"},"description":"Filter last edit of QR code up to this datetime (inclusive) *- example: 2025-09-27 23:59:59*"},{"name":"first_scan_at_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter first scan of QR code from this datetime (inclusive) *- example: 2025-09-27 00:00:01*","title":"First Scan At From"},"description":"Filter first scan of QR code from this datetime (inclusive) *- example: 2025-09-27 00:00:01*"},{"name":"first_scan_at_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter first scan of QR code up to this datetime (inclusive) *- example: 2025-09-27 23:59:59*","title":"First Scan At To"},"description":"Filter first scan of QR code up to this datetime (inclusive) *- example: 2025-09-27 23:59:59*"},{"name":"last_scan_at_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter last scan of QR code from this datetime (inclusive) *- example: 2025-09-27 00:00:01*","title":"Last Scan At From"},"description":"Filter last scan of QR code from this datetime (inclusive) *- example: 2025-09-27 00:00:01*"},{"name":"last_scan_at_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Filter last scan of QR code up to this datetime (inclusive) *- example: 2025-09-27 23:59:59*","title":"Last Scan At To"},"description":"Filter last scan of QR code up to this datetime (inclusive) *- example: 2025-09-27 23:59:59*"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size","default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_QRCodeOut_"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl \\\n -X GET \\\n --max-time 10 \\\n -H 'Authorization: Bearer public:YOURDOMAIN.COM:XXXXXXX:YYYYYYY' \\\n 'https://api.qrplanet.com/api/v2/qrcodes?page=1&type=URL'\n"},{"lang":"python","source":"# pip install requests\nimport requests\n\nurl = 'https://api.qrplanet.com/api/v2/qrcodes'\nheaders = {'Authorization': 'Bearer public:YOURDOMAIN.COM:XXXXXXX:YYYYYYY'}\nparams = {'page': 1, 'type': 'URL'}\n\ntimeout_seconds = 10\n\nr = requests.request('GET', url, headers=headers, params=params, timeout=timeout_seconds)\n\nprint(r.status_code)\n\ntry:\n data = r.json() # dict/list if response is JSON\n print(data)\nexcept ValueError:\n print(r.text)"},{"lang":"php","source":" 1, 'type' => 'URL'];\n$query = http_build_query($params);\n$url = $query ? ($url . '?' . $query) : $url;\n\n$headers = ['Authorization: Bearer public:YOURDOMAIN.COM:XXXXXXX:YYYYYYY'];\n\n$ch = curl_init($url);\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\ncurl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');\ncurl_setopt($ch, CURLOPT_HTTPHEADER, $headers);\ncurl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 10);\ncurl_setopt($ch, CURLOPT_TIMEOUT, 10);\n\n$resp = curl_exec($ch);\n$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);\ncurl_close($ch);\n\necho $status . \"\\n\";\n\n$data = json_decode($resp, true); // assoc array if JSON\nif (json_last_error() === JSON_ERROR_NONE) {\n print_r($data);\n} else {\n echo $resp . \"\\n\";\n}\n?>"},{"lang":"go","source":"package main\n\nimport (\n \"fmt\"\n \"io\"\n \"net/http\"\n \"net/url\"\n \"time\"\n \"encoding/json\"\n)\n\nfunc main() {\n baseURL := \"https://api.qrplanet.com/api/v2/qrcodes\"\n u, err := url.Parse(baseURL)\n if err != nil {\n panic(err)\n }\n\n q := u.Query()\n q.Set(\"page\", \"1\")\n q.Set(\"type\", \"URL\")\n u.RawQuery = q.Encode()\n\n timeout := 10 * time.Second\n client := &http.Client{Timeout: timeout}\n\n var body io.Reader = nil\n\n req, err := http.NewRequest(\"GET\", u.String(), body)\n if err != nil {\n panic(err)\n }\n\n req.Header.Set(\"Authorization\", \"Bearer public:YOURDOMAIN.COM:XXXXXXX:YYYYYYY\")\n\n resp, err := client.Do(req)\n if err != nil {\n panic(err)\n }\n defer resp.Body.Close()\n\n fmt.Println(resp.StatusCode)\n\n b, err := io.ReadAll(resp.Body)\n if err != nil {\n panic(err)\n }\n\n var data any\n if err := json.Unmarshal(b, &data); err == nil {\n pretty, _ := json.MarshalIndent(data, \"\", \" \")\n fmt.Println(string(pretty))\n } else {\n fmt.Println(string(b))\n }\n}"}]},"post":{"tags":["QR Codes"],"summary":"Create a QR code","description":"Creates a dynamic or static QR Code.\n\nBe aware that only for dynamic QR codes analytics are available and the target url can be changed later.\n\nYou find some common examples below:\nUse Case|Values\n---|---\nDynamic: Simplest form of a QR code|`target_url` = `https://test.de`\nDynamic: With custom slug|`target_url` = `https://test.de`, `slug` = `easter-promotion-2`\nDynamic: Manually setting title and description|`target_url` = `https://test.de`, `title` = `my title for this qr code`, `description` = `my description for this qr code`\nDynamic: Password|`target_url` = `https://test.de/secret-content`, `password` = `password123`\nDynamic: Notifications|`target_url` = `https://test.de`, `notify_email` = `True`, `notify_sms` = `True`\nStatic: URL (!)|`static` = `True`, `content` = `https://mystaticwebsite.com`\nStatic: Phone number|`static` = `True`, `content` = `+18552700999`\nStatic: SMS|`static` = `True`, `content` = `SMSTO:+18552700999:This is my sms text message`\nStatic: Email|`static` = `True`, `content` = `MATMSG:TO:myemail@mycompany.com;SUB:mysubject;BODY:my email message text;;`\nStatic: Wifi|`static` = `True`, `content` = `WIFI:S:myssid;T:WPA;P:mypassword;;`\nStatic: Bitcoin|`static` = `True`, `content` = `bitcoin:16sym9PubRco4nekDa2ZC9VYZuSwzSc999?amount=0.1`\nStatic: SEPA|`static` = `True`, `content` = `DE89 3704 0044 0532 0130 00`","operationId":"crate_qr_code","security":[{"HTTPBearer":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QRCodeCreate"},"examples":{"Dynamic_Simplest":{"summary":"Dynamic: Simplest form of a QR code","description":"Here you just provide the targt url.","value":{"target_url":"https://test.de"}},"Dynamic_Slug":{"summary":"Dynamic: With custom slug","description":"Here you provide a custom slug that should be used (sometimes referred to as Vanity URL in the frontend UI). In the rest of the API you can access the QR code then via this slug in the `code` path parameter like GET /api/v2/qrcodes/{code}","value":{"target_url":"https://test.de","slug":"easter-promotion-2"}},"Dynamic_Title":{"summary":"Dynamic: Manually setting title and description","description":"You can manually set the title and description of a QR code.","value":{"target_url":"https://test.de","title":"my title for this qr code","description":"my description for this qr code"}},"Dynamic_Password":{"summary":"Dynamic: Password","description":"You can set a password that a user has to provide after scanning the QR code to be able to reach the target url.","value":{"target_url":"https://test.de/secret-content","password":"password123"}},"Dynamic_Notifications":{"summary":"Dynamic: Notifications","description":"You can enable email and sms notification.","value":{"target_url":"https://test.de","notify_email":true,"notify_sms":true}},"Static_URL":{"summary":"Static: URL (!)","description":"You can also provide a URL in a static form. Be aware: the url cannot be changed in the future since its directly encoded in the QR code.","value":{"static":true,"content":"https://mystaticwebsite.com"}},"Static_Phone":{"summary":"Static: Phone number","value":{"static":true,"content":"+18552700999"}},"Static_SMS":{"summary":"Static: SMS","value":{"static":true,"content":"SMSTO:+18552700999:This is my sms text message"}},"Static_Email":{"summary":"Static: Email","value":{"static":true,"content":"MATMSG:TO:myemail@mycompany.com;SUB:mysubject;BODY:my email message text;;"}},"Static_Wifi":{"summary":"Static: Wifi","value":{"static":true,"content":"WIFI:S:myssid;T:WPA;P:mypassword;;"}},"Static_Bitcoin":{"summary":"Static: Bitcoin","value":{"static":true,"content":"bitcoin:16sym9PubRco4nekDa2ZC9VYZuSwzSc999?amount=0.1"}},"Static_SEPA":{"summary":"Static: SEPA","value":{"static":true,"content":"DE89 3704 0044 0532 0130 00"}}}}}},"responses":{"201":{"description":"CREATED","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QRCodeCreateOut"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl \\\n -X POST \\\n --max-time 10 \\\n -H 'Authorization: Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"target_url\": \"https://test.de\"\n}' \\\n 'https://api.qrplanet.com/api/v2/qrcodes'\n"},{"lang":"python","source":"# pip install requests\nimport requests\n\nurl = 'https://api.qrplanet.com/api/v2/qrcodes'\nheaders = {'Authorization': 'Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY', 'Content-Type': 'application/json'}\nparams = None\n\ntimeout_seconds = 10\n\njson_body = {'target_url': 'https://test.de'}\n\nr = requests.request('POST', url, headers=headers, params=params, json=json_body, timeout=timeout_seconds)\n\nprint(r.status_code)\n\ntry:\n data = r.json() # dict/list if response is JSON\n print(data)\nexcept ValueError:\n print(r.text)"},{"lang":"php","source":""},{"lang":"go","source":"package main\n\nimport (\n \"fmt\"\n \"io\"\n \"net/http\"\n \"net/url\"\n \"time\"\n \"strings\"\n \"encoding/json\"\n)\n\nfunc main() {\n baseURL := \"https://api.qrplanet.com/api/v2/qrcodes\"\n u, err := url.Parse(baseURL)\n if err != nil {\n panic(err)\n }\n\n timeout := 10 * time.Second\n client := &http.Client{Timeout: timeout}\n\n var body io.Reader = nil\n body = strings.NewReader(`{\n \"target_url\": \"https://test.de\"\n}`)\n\n req, err := http.NewRequest(\"POST\", u.String(), body)\n if err != nil {\n panic(err)\n }\n\n req.Header.Set(\"Authorization\", \"Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY\")\n req.Header.Set(\"Content-Type\", \"application/json\")\n\n resp, err := client.Do(req)\n if err != nil {\n panic(err)\n }\n defer resp.Body.Close()\n\n fmt.Println(resp.StatusCode)\n\n b, err := io.ReadAll(resp.Body)\n if err != nil {\n panic(err)\n }\n\n var data any\n if err := json.Unmarshal(b, &data); err == nil {\n pretty, _ := json.MarshalIndent(data, \"\", \" \")\n fmt.Println(string(pretty))\n } else {\n fmt.Println(string(b))\n }\n}"}]},"delete":{"tags":["QR Codes"],"summary":"Delete ALL QR Codes","description":"Deletes ALL QR Codes of this user. Be careful, this operation cannot be undone!","operationId":"delete_all_qr_codes","security":[{"HTTPBearer":[]}],"parameters":[{"name":"confirm","in":"query","required":true,"schema":{"type":"string","description":"Must be 'DELETE_ALL' to confirm. This is a security measure.","title":"Confirm"},"description":"Must be 'DELETE_ALL' to confirm. This is a security measure."}],"responses":{"204":{"description":"No content - deletion successful"},"404":{"description":"QR code not found","content":{"application/json":{"example":{"detail":"QR code not found"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl \\\n -X DELETE \\\n --max-time 10 \\\n -H 'Authorization: Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY' \\\n 'https://api.qrplanet.com/api/v2/qrcodes?confirm=DELETE_ALL'"},{"lang":"python","source":"# pip install requests\nimport requests\n\nurl = 'https://api.qrplanet.com/api/v2/qrcodes'\nheaders = {'Authorization': 'Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY'}\nparams = {'confirm': 'DELETE_ALL'}\n\ntimeout_seconds = 10\n\nr = requests.request('DELETE', url, headers=headers, params=params, timeout=timeout_seconds)\n\nprint(r.status_code)\n\nprint(r.status_code)\nprint(r.text) # for binary/file endpoints, handle r.content instead"},{"lang":"php","source":" 'DELETE_ALL'];\n$query = http_build_query($params);\n$url = $query ? ($url . '?' . $query) : $url;\n\n$headers = ['Authorization: Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY'];\n\n$ch = curl_init($url);\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\ncurl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');\ncurl_setopt($ch, CURLOPT_HTTPHEADER, $headers);\ncurl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 10);\ncurl_setopt($ch, CURLOPT_TIMEOUT, 10);\n\n$resp = curl_exec($ch);\n$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);\ncurl_close($ch);\n\necho $status . \"\\n\";\n\necho $resp . \"\\n\";\n?>"},{"lang":"go","source":"package main\n\nimport (\n \"fmt\"\n \"io\"\n \"net/http\"\n \"net/url\"\n \"time\"\n)\n\nfunc main() {\n baseURL := \"https://api.qrplanet.com/api/v2/qrcodes\"\n u, err := url.Parse(baseURL)\n if err != nil {\n panic(err)\n }\n\n q := u.Query()\n q.Set(\"confirm\", \"DELETE_ALL\")\n u.RawQuery = q.Encode()\n\n timeout := 10 * time.Second\n client := &http.Client{Timeout: timeout}\n\n var body io.Reader = nil\n\n req, err := http.NewRequest(\"DELETE\", u.String(), body)\n if err != nil {\n panic(err)\n }\n\n req.Header.Set(\"Authorization\", \"Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY\")\n\n resp, err := client.Do(req)\n if err != nil {\n panic(err)\n }\n defer resp.Body.Close()\n\n fmt.Println(resp.StatusCode)\n\n b, err := io.ReadAll(resp.Body)\n if err != nil {\n panic(err)\n }\n\n fmt.Println(string(b))\n}"}]}},"/api/v2/qrcodes/{code}":{"get":{"tags":["QR Codes"],"summary":"Get a QR Code","description":"Returns a single QR code by its unique identifier.","operationId":"get_qr_code","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*","title":"Code"},"description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QRCodeDetailOut"}}}},"404":{"description":"QR code not found","content":{"application/json":{"example":{"detail":"QR code not found"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl \\\n -X GET \\\n --max-time 10 \\\n -H 'Authorization: Bearer public:YOURDOMAIN.COM:XXXXXXX:YYYYYYY' \\\n 'https://api.qrplanet.com/api/v2/qrcodes/easter-promotion-2'\n"},{"lang":"python","source":"# pip install requests\nimport requests\n\nurl = 'https://api.qrplanet.com/api/v2/qrcodes/easter-promotion-2'\nheaders = {'Authorization': 'Bearer public:YOURDOMAIN.COM:XXXXXXX:YYYYYYY'}\nparams = None\n\ntimeout_seconds = 10\n\nr = requests.request('GET', url, headers=headers, params=params, timeout=timeout_seconds)\n\nprint(r.status_code)\n\ntry:\n data = r.json() # dict/list if response is JSON\n print(data)\nexcept ValueError:\n print(r.text)"},{"lang":"php","source":""},{"lang":"go","source":"package main\n\nimport (\n \"fmt\"\n \"io\"\n \"net/http\"\n \"net/url\"\n \"time\"\n \"encoding/json\"\n)\n\nfunc main() {\n baseURL := \"https://api.qrplanet.com/api/v2/qrcodes/easter-promotion-2\"\n u, err := url.Parse(baseURL)\n if err != nil {\n panic(err)\n }\n\n timeout := 10 * time.Second\n client := &http.Client{Timeout: timeout}\n\n var body io.Reader = nil\n\n req, err := http.NewRequest(\"GET\", u.String(), body)\n if err != nil {\n panic(err)\n }\n\n req.Header.Set(\"Authorization\", \"Bearer public:YOURDOMAIN.COM:XXXXXXX:YYYYYYY\")\n\n resp, err := client.Do(req)\n if err != nil {\n panic(err)\n }\n defer resp.Body.Close()\n\n fmt.Println(resp.StatusCode)\n\n b, err := io.ReadAll(resp.Body)\n if err != nil {\n panic(err)\n }\n\n var data any\n if err := json.Unmarshal(b, &data); err == nil {\n pretty, _ := json.MarshalIndent(data, \"\", \" \")\n fmt.Println(string(pretty))\n } else {\n fmt.Println(string(b))\n }\n}"}]},"delete":{"tags":["QR Codes"],"summary":"Delete a QR Code","description":"Deletes a QR Code identified by its code.","operationId":"delete_qr_code","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*","title":"Code"},"description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*"}],"responses":{"204":{"description":"No content - deletion successful"},"404":{"description":"QR code not found","content":{"application/json":{"example":{"detail":"QR code not found"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl \\\n -X DELETE \\\n --max-time 10 \\\n -H 'Authorization: Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY' \\\n 'https://api.qrplanet.com/api/v2/qrcodes/easter-promotion-2'"},{"lang":"python","source":"# pip install requests\nimport requests\n\nurl = 'https://api.qrplanet.com/api/v2/qrcodes/easter-promotion-2'\nheaders = {'Authorization': 'Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY'}\nparams = None\n\ntimeout_seconds = 10\n\nr = requests.request('DELETE', url, headers=headers, params=params, timeout=timeout_seconds)\n\nprint(r.status_code)\n\nprint(r.status_code)\nprint(r.text) # for binary/file endpoints, handle r.content instead"},{"lang":"php","source":""},{"lang":"go","source":"package main\n\nimport (\n \"fmt\"\n \"io\"\n \"net/http\"\n \"net/url\"\n \"time\"\n)\n\nfunc main() {\n baseURL := \"https://api.qrplanet.com/api/v2/qrcodes/easter-promotion-2\"\n u, err := url.Parse(baseURL)\n if err != nil {\n panic(err)\n }\n\n timeout := 10 * time.Second\n client := &http.Client{Timeout: timeout}\n\n var body io.Reader = nil\n\n req, err := http.NewRequest(\"DELETE\", u.String(), body)\n if err != nil {\n panic(err)\n }\n\n req.Header.Set(\"Authorization\", \"Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY\")\n\n resp, err := client.Do(req)\n if err != nil {\n panic(err)\n }\n defer resp.Body.Close()\n\n fmt.Println(resp.StatusCode)\n\n b, err := io.ReadAll(resp.Body)\n if err != nil {\n panic(err)\n }\n\n fmt.Println(string(b))\n}"}]},"patch":{"tags":["QR Codes"],"summary":"Change certain fields of a QR Code","description":"Change certain fields of a QR Code identified by its code.","operationId":"change_qr_code","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*","title":"Code"},"description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QRCodePatch"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QRCodeDetailOut"}}}},"404":{"description":"QR code not found","content":{"application/json":{"example":{"detail":"QR code not found"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl \\\n -X PATCH \\\n --max-time 10 \\\n -H 'Authorization: Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"target_url\": \"https://test.de/new-url\",\n \"title\": \"Easter Promotion 2 2025 New Title\"\n}' \\\n 'https://api.qrplanet.com/api/v2/qrcodes/easter-promotion-2'\n"},{"lang":"python","source":"# pip install requests\nimport requests\n\nurl = 'https://api.qrplanet.com/api/v2/qrcodes/easter-promotion-2'\nheaders = {'Authorization': 'Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY', 'Content-Type': 'application/json'}\nparams = None\n\ntimeout_seconds = 10\n\njson_body = {'target_url': 'https://test.de/new-url', 'title': 'Easter Promotion 2 2025 New Title'}\n\nr = requests.request('PATCH', url, headers=headers, params=params, json=json_body, timeout=timeout_seconds)\n\nprint(r.status_code)\n\ntry:\n data = r.json() # dict/list if response is JSON\n print(data)\nexcept ValueError:\n print(r.text)"},{"lang":"php","source":""},{"lang":"go","source":"package main\n\nimport (\n \"fmt\"\n \"io\"\n \"net/http\"\n \"net/url\"\n \"time\"\n \"strings\"\n \"encoding/json\"\n)\n\nfunc main() {\n baseURL := \"https://api.qrplanet.com/api/v2/qrcodes/easter-promotion-2\"\n u, err := url.Parse(baseURL)\n if err != nil {\n panic(err)\n }\n\n timeout := 10 * time.Second\n client := &http.Client{Timeout: timeout}\n\n var body io.Reader = nil\n body = strings.NewReader(`{\n \"target_url\": \"https://test.de/new-url\",\n \"title\": \"Easter Promotion 2 2025 New Title\"\n}`)\n\n req, err := http.NewRequest(\"PATCH\", u.String(), body)\n if err != nil {\n panic(err)\n }\n\n req.Header.Set(\"Authorization\", \"Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY\")\n req.Header.Set(\"Content-Type\", \"application/json\")\n\n resp, err := client.Do(req)\n if err != nil {\n panic(err)\n }\n defer resp.Body.Close()\n\n fmt.Println(resp.StatusCode)\n\n b, err := io.ReadAll(resp.Body)\n if err != nil {\n panic(err)\n }\n\n var data any\n if err := json.Unmarshal(b, &data); err == nil {\n pretty, _ := json.MarshalIndent(data, \"\", \" \")\n fmt.Println(string(pretty))\n } else {\n fmt.Println(string(b))\n }\n}"}]}},"/api/v2/qrcodes/{code}/download-image/basic":{"get":{"tags":["QR Codes","GS1 Digital Link"],"summary":"Download the image of a QR Code without a Designer QR code template","description":"Download the image of a QR Code in black/white without a Designer QR code template","operationId":"download_image_basic_qr_code","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*","title":"Code"},"description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*"},{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/ImageFormatBasic"},{"type":"null"}],"description":"The format the generated image should have *- example: PNG*","default":"PNG","title":"Format"},"description":"The format the generated image should have *- example: PNG*"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":30,"minimum":1,"description":"Size of the image from 1-30 (only relevant for PNG) *- example: 30*","default":10,"title":"Size"},"description":"Size of the image from 1-30 (only relevant for PNG) *- example: 30*"},{"name":"error_correction_level","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/ErrorCorrectionLevel"},{"type":"null"}],"description":"The error correction level (L, M, Q, H) *- example: L*","default":"L","title":"Error Correction Level"},"description":"The error correction level (L, M, Q, H) *- example: L*"},{"name":"padding","in":"query","required":false,"schema":{"type":"integer","maximum":30,"minimum":0,"description":"Padding around the QR code *- example: 4*","default":4,"title":"Padding"},"description":"Padding around the QR code *- example: 4*"},{"name":"show_title","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Show the title of the QR code below the image *- example: false*","default":false,"title":"Show Title"},"description":"Show the title of the QR code below the image *- example: false*"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{}}}},"404":{"description":"QR code not found","content":{"application/json":{"example":{"detail":"QR code not found"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl \\\n -X GET \\\n --max-time 10 \\\n -H 'Authorization: Bearer public:YOURDOMAIN.COM:XXXXXXX:YYYYYYY' \\\n 'https://api.qrplanet.com/api/v2/qrcodes/easter-promotion-2/download-image/basic?format=SVG&padding=5&show_title=True&size=15'"},{"lang":"python","source":"# pip install requests\nimport requests\n\nurl = 'https://api.qrplanet.com/api/v2/qrcodes/easter-promotion-2/download-image/basic'\nheaders = {'Authorization': 'Bearer public:YOURDOMAIN.COM:XXXXXXX:YYYYYYY'}\nparams = {'format': 'SVG', 'padding': 5, 'show_title': True, 'size': 15}\n\ntimeout_seconds = 10\n\nr = requests.request('GET', url, headers=headers, params=params, timeout=timeout_seconds)\n\nprint(r.status_code)\n\nprint(r.status_code)\nprint(r.text) # for binary/file endpoints, handle r.content instead"},{"lang":"php","source":" 'SVG', 'padding' => 5, 'show_title' => true, 'size' => 15];\n$query = http_build_query($params);\n$url = $query ? ($url . '?' . $query) : $url;\n\n$headers = ['Authorization: Bearer public:YOURDOMAIN.COM:XXXXXXX:YYYYYYY'];\n\n$ch = curl_init($url);\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\ncurl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');\ncurl_setopt($ch, CURLOPT_HTTPHEADER, $headers);\ncurl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 10);\ncurl_setopt($ch, CURLOPT_TIMEOUT, 10);\n\n$resp = curl_exec($ch);\n$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);\ncurl_close($ch);\n\necho $status . \"\\n\";\n\necho $resp . \"\\n\";\n?>"},{"lang":"go","source":"package main\n\nimport (\n \"fmt\"\n \"io\"\n \"net/http\"\n \"net/url\"\n \"time\"\n)\n\nfunc main() {\n baseURL := \"https://api.qrplanet.com/api/v2/qrcodes/easter-promotion-2/download-image/basic\"\n u, err := url.Parse(baseURL)\n if err != nil {\n panic(err)\n }\n\n q := u.Query()\n q.Set(\"format\", \"SVG\")\n q.Set(\"padding\", \"5\")\n q.Set(\"show_title\", \"True\")\n q.Set(\"size\", \"15\")\n u.RawQuery = q.Encode()\n\n timeout := 10 * time.Second\n client := &http.Client{Timeout: timeout}\n\n var body io.Reader = nil\n\n req, err := http.NewRequest(\"GET\", u.String(), body)\n if err != nil {\n panic(err)\n }\n\n req.Header.Set(\"Authorization\", \"Bearer public:YOURDOMAIN.COM:XXXXXXX:YYYYYYY\")\n\n resp, err := client.Do(req)\n if err != nil {\n panic(err)\n }\n defer resp.Body.Close()\n\n fmt.Println(resp.StatusCode)\n\n b, err := io.ReadAll(resp.Body)\n if err != nil {\n panic(err)\n }\n\n fmt.Println(string(b))\n}"}]}},"/api/v2/qrcodes/{code}/download-image/designer":{"get":{"tags":["QR Codes","Designer Templates","GS1 Digital Link"],"summary":"Download the image of a QR Code based on a Designer QR code template","description":"Download the image of a QR Code in the design of a Designer QR code template","operationId":"download_image_designer_qr_code","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*","title":"Code"},"description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*"},{"name":"designer_template_id","in":"query","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The the designer template you want to use *- example: 42f88fb1de80ca479f87942c23ea74be*","title":"Designer Template Id"},"description":"The the designer template you want to use *- example: 42f88fb1de80ca479f87942c23ea74be*"},{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/ImageFormatDesigner"},{"type":"null"}],"description":"The format the generated image should have *- example: SVG*","default":"SVG","title":"Format"},"description":"The format the generated image should have *- example: SVG*"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{}}}},"404":{"description":"QR code not found","content":{"application/json":{"example":{"detail":"QR code not found"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl \\\n -X GET \\\n --max-time 10 \\\n -H 'Authorization: Bearer public:YOURDOMAIN.COM:XXXXXXX:YYYYYYY' \\\n 'https://api.qrplanet.com/api/v2/qrcodes/easter-promotion-2/download-image/designer?designer_template_id=42f88fb1de80ca479f87942c23ea74be&format=PNG'"},{"lang":"python","source":"# pip install requests\nimport requests\n\nurl = 'https://api.qrplanet.com/api/v2/qrcodes/easter-promotion-2/download-image/designer'\nheaders = {'Authorization': 'Bearer public:YOURDOMAIN.COM:XXXXXXX:YYYYYYY'}\nparams = {'designer_template_id': '42f88fb1de80ca479f87942c23ea74be', 'format': 'PNG'}\n\ntimeout_seconds = 10\n\nr = requests.request('GET', url, headers=headers, params=params, timeout=timeout_seconds)\n\nprint(r.status_code)\n\nprint(r.status_code)\nprint(r.text) # for binary/file endpoints, handle r.content instead"},{"lang":"php","source":" '42f88fb1de80ca479f87942c23ea74be', 'format' => 'PNG'];\n$query = http_build_query($params);\n$url = $query ? ($url . '?' . $query) : $url;\n\n$headers = ['Authorization: Bearer public:YOURDOMAIN.COM:XXXXXXX:YYYYYYY'];\n\n$ch = curl_init($url);\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\ncurl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');\ncurl_setopt($ch, CURLOPT_HTTPHEADER, $headers);\ncurl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 10);\ncurl_setopt($ch, CURLOPT_TIMEOUT, 10);\n\n$resp = curl_exec($ch);\n$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);\ncurl_close($ch);\n\necho $status . \"\\n\";\n\necho $resp . \"\\n\";\n?>"},{"lang":"go","source":"package main\n\nimport (\n \"fmt\"\n \"io\"\n \"net/http\"\n \"net/url\"\n \"time\"\n)\n\nfunc main() {\n baseURL := \"https://api.qrplanet.com/api/v2/qrcodes/easter-promotion-2/download-image/designer\"\n u, err := url.Parse(baseURL)\n if err != nil {\n panic(err)\n }\n\n q := u.Query()\n q.Set(\"designer_template_id\", \"42f88fb1de80ca479f87942c23ea74be\")\n q.Set(\"format\", \"PNG\")\n u.RawQuery = q.Encode()\n\n timeout := 10 * time.Second\n client := &http.Client{Timeout: timeout}\n\n var body io.Reader = nil\n\n req, err := http.NewRequest(\"GET\", u.String(), body)\n if err != nil {\n panic(err)\n }\n\n req.Header.Set(\"Authorization\", \"Bearer public:YOURDOMAIN.COM:XXXXXXX:YYYYYYY\")\n\n resp, err := client.Do(req)\n if err != nil {\n panic(err)\n }\n defer resp.Body.Close()\n\n fmt.Println(resp.StatusCode)\n\n b, err := io.ReadAll(resp.Body)\n if err != nil {\n panic(err)\n }\n\n fmt.Println(string(b))\n}"}]}},"/api/v2/qrcodes/{code}/stats":{"get":{"tags":["QR Codes","Analytics"],"summary":"Get the statistics of a QR Code","description":"Get the QR Code statistics identified by its code.","operationId":"get_qr_code_stats","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*","title":"Code"},"description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*"},{"name":"country_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by country code (exact match) *- example: DE*","title":"Country Code"},"description":"Filter by country code (exact match) *- example: DE*"},{"name":"scan_date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Filter scans of QR code from this date (inclusive) *- example: 2025-09-27*","title":"Scan Date From"},"description":"Filter scans of QR code from this date (inclusive) *- example: 2025-09-27*"},{"name":"scan_date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Filter scans of QR code up to this date (inclusive) *- example: 2025-09-30*","title":"Scan Date To"},"description":"Filter scans of QR code up to this date (inclusive) *- example: 2025-09-30*"},{"name":"scan_date_relative_range","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/DateRelativeRange"},{"type":"null"}],"description":"Filter scans of QR code via a relative day range selector","title":"Scan Date Relative Range"},"description":"Filter scans of QR code via a relative day range selector"},{"name":"sort_order","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/SortOrder"},{"type":"null"}],"description":"Sort the result by scan date ascending or descending","title":"Sort Order"},"description":"Sort the result by scan date ascending or descending"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageWithSummary_ScanStatSummary_ScanStatItem_"}}}},"404":{"description":"QR code not found","content":{"application/json":{"example":{"detail":"QR code not found"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/qrcodes/{code}/stats/reset":{"post":{"tags":["QR Codes","Analytics"],"summary":"Resets the statistics of a QR Code","description":"Resets the QR Code statistics identified by its code.","operationId":"reset_qr_code_stats","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*","title":"Code"},"description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*"}],"responses":{"204":{"description":"No content - resest successful"},"404":{"description":"QR code not found","content":{"application/json":{"example":{"detail":"QR code not found"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/qrcodes/{code}/tags":{"get":{"tags":["QR Codes","Tags"],"summary":"Get the tags of a QR Code","description":"Get the tags that have been assigned to a QR code.","operationId":"get_qr_code_tags","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*","title":"Code"},"description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagsOut"}}}},"404":{"description":"QR code not found","content":{"application/json":{"example":{"detail":"QR code not found"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["QR Codes","Tags"],"summary":"Change the tags of a QR Code","description":"Change the tags of a QR Code identified by its code.","operationId":"change_qr_code_tags","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*","title":"Code"},"description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagsPatch"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagsOut"}}}},"404":{"description":"QR code not found","content":{"application/json":{"example":{"detail":"QR code not found"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["QR Codes","Tags"],"summary":"Remove all tags of a QR Code","description":"Remove all the tags of a QR Code identified by its code.","operationId":"delete_qr_code_tags","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*","title":"Code"},"description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*"}],"responses":{"204":{"description":"No content"},"404":{"description":"QR code not found","content":{"application/json":{"example":{"detail":"QR code not found"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/qrcodes/{code}/countries":{"post":{"tags":["QR Codes","Geo Fencing"],"summary":"Add a country-specific target to a QR Code","description":"Add a country specific target URL to a QR code identified by its code. If the QR code gets scanned in a specific country then the user gets forwarded to this target url.","operationId":"add_qr_code_country","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*","title":"Code"},"description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountryAddRequest"}}}},"responses":{"201":{"description":"CREATED","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountryAddResponse"}}}},"404":{"description":"QR code not found","content":{"application/json":{"example":{"detail":"QR code not found"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/qrcodes/{code}/countries/{country_code}":{"delete":{"tags":["QR Codes","Geo Fencing"],"summary":"Remove a country-specific target of a QR Code","description":"Remove a country specific target URL to a QR code identified by its code.","operationId":"delete_qr_code_country","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*","title":"Code"},"description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*"},{"name":"country_code","in":"path","required":true,"schema":{"type":"string","description":"2-letter country code *- example: IT*","title":"Country Code"},"description":"2-letter country code *- example: IT*"}],"responses":{"204":{"description":"No content"},"404":{"description":"QR code not found","content":{"application/json":{"example":{"detail":"QR code not found"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/qrcodes/{code}/languages":{"post":{"tags":["QR Codes","Geo Fencing"],"summary":"Add a language-specific target to a QR Code","description":"Add a language-specific target URL to a QR code identified by its code. If the QR code gets scanned with a device in a certain language then the user gets forwarded to this target url.","operationId":"add_qr_code_language","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*","title":"Code"},"description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanguageAddRequest"}}}},"responses":{"201":{"description":"CREATED","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanguageAddResponse"}}}},"404":{"description":"QR code not found","content":{"application/json":{"example":{"detail":"QR code not found"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/qrcodes/{code}/languages/{language_code}":{"delete":{"tags":["QR Codes","Geo Fencing"],"summary":"Remove a language-specific target of a QR Code","description":"Remove a language-specific target URL to a QR code identified by its code.","operationId":"delete_qr_code_language","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*","title":"Code"},"description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*"},{"name":"language_code","in":"path","required":true,"schema":{"type":"string","description":"2-letter language code *- example: IT*","title":"Language Code"},"description":"2-letter language code *- example: IT*"}],"responses":{"204":{"description":"No content"},"404":{"description":"QR code not found","content":{"application/json":{"example":{"detail":"QR code not found"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/qrcodes/{code}/geofences":{"post":{"tags":["QR Codes","Geo Fencing"],"summary":"Add a geo-location-specific target to a QR Code","description":"Add a geo-location-specific target URL to a QR code identified by its code. If the QR code gets scanned with that specific location then the user gets forwarded to this target url. If you set the MULTI_GEO or MULTI_GEO_CLOSEST type when creating the Geofenced QR Code with the API, you can add geofence rules.","operationId":"add_qr_code_geofence","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*","title":"Code"},"description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeoFenceAddRequest"}}}},"responses":{"201":{"description":"CREATED","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeoFenceAddResponse"}}}},"404":{"description":"QR code not found","content":{"application/json":{"example":{"detail":"QR code not found"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/qrcodes/{code}/geofences/{geofence_id}":{"delete":{"tags":["QR Codes","Geo Fencing"],"summary":"Remove a geo-location-specific target of a QR Code","description":"Remove a geofence (lat, lng, radius)-specific target URL to a QR code identified by its code.","operationId":"delete_qr_code_geofence","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*","title":"Code"},"description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*"},{"name":"geofence_id","in":"path","required":true,"schema":{"type":"string","description":"Geofence target rule ID.","title":"Geofence Id"},"description":"Geofence target rule ID."}],"responses":{"204":{"description":"No content"},"404":{"description":"QR code not found","content":{"application/json":{"example":{"detail":"QR code not found"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/qrcodes/{code}/georegions":{"post":{"tags":["QR Codes","Geo Fencing"],"summary":"Add a geo-region-specific target to a QR Code","description":"Add a geo-region-specific target URL to a QR code identified by its code. If the QR code gets scanned with that specific location then the user gets forwarded to this target url. If you set the MULTI_REGION type when creating the Geofenced QR Code with the API, you can add rules to match against regions as well.","operationId":"add_qr_code_georegion","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*","title":"Code"},"description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeoRegionAddRequest"}}}},"responses":{"201":{"description":"CREATED","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeoRegionAddResponse"}}}},"404":{"description":"QR code not found","content":{"application/json":{"example":{"detail":"QR code not found"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/qrcodes/{code}/georegions/{georegion_id}":{"delete":{"tags":["QR Codes","Geo Fencing"],"summary":"Remove a geo-region-specific target of a QR Code","description":"Remove a georegion-specific target URL to a QR code identified by its code.","operationId":"delete_qr_code_georegion","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*","title":"Code"},"description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*"},{"name":"georegion_id","in":"path","required":true,"schema":{"type":"string","description":"Geo Region target rule ID.","title":"Georegion Id"},"description":"Geo Region target rule ID."}],"responses":{"204":{"description":"No content"},"404":{"description":"QR code not found","content":{"application/json":{"example":{"detail":"QR code not found"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/qrcodes/{code}/leads":{"get":{"tags":["QR Codes","Leads"],"summary":"Get the leads of a landingpage.","description":"Get the ledas of a landingpage","operationId":"get_leads","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*","title":"Code"},"description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*"},{"name":"referrer","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The referrer you want to filter by *- example: https://yourdomain.com/your-landingpage*","title":"Referrer"},"description":"The referrer you want to filter by *- example: https://yourdomain.com/your-landingpage*"},{"name":"format","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/LeadExportFormat"},{"type":"null"}],"description":"The format the lead list should have. The pagination only applies to JSON. For CSV and XLSX the whole list is returned. *- example: JSON*","default":"JSON","title":"Format"},"description":"The format the lead list should have. The pagination only applies to JSON. For CSV and XLSX the whole list is returned. *- example: JSON*"},{"name":"csv_delimiter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"In case of a CSV export (format=CSV): the csv delimiter between the values. Usually the delimiter is `,` (US), `;` (Europe), `|` (machine 2 machine) or `TAB` for tabulator. *- example: ;*","default":",","title":"Csv Delimiter"},"description":"In case of a CSV export (format=CSV): the csv delimiter between the values. Usually the delimiter is `,` (US), `;` (Europe), `|` (machine 2 machine) or `TAB` for tabulator. *- example: ;*"},{"name":"csv_decimal_separator","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/DecimalSeparator"},{"type":"null"}],"description":"In case of a CSV export (format=CSV): decimal separator for numeric values. Use `.` (default, US, API/machine-friendly) or `,` (common in Europe). *- example: ,*","default":".","title":"Csv Decimal Separator"},"description":"In case of a CSV export (format=CSV): decimal separator for numeric values. Use `.` (default, US, API/machine-friendly) or `,` (common in Europe). *- example: ,*"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size","default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_LeadItem_"}}}},"404":{"description":"QR code not found","content":{"application/json":{"example":{"detail":"QR code not found"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/qrcodes/{code}/change-type":{"post":{"tags":["QR Codes"],"summary":"Change the type of a QR Code","description":"Change the type and target url of the QR Code identified by its code.","operationId":"change_qr_code_type","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*","title":"Code"},"description":"Code that identifies a QR code. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. In case of a GS1 QR code its a random hash value. *- example: easter-promotion-2*"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TypeChangeRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TypeChangeResponse"}}}},"404":{"description":"QR code not found","content":{"application/json":{"example":{"detail":"QR code not found"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/folders":{"get":{"tags":["Folders"],"summary":"List Folders","description":"Returns a paginated list of your folders.","operationId":"list_folders","security":[{"HTTPBearer":[]}],"parameters":[{"name":"type","in":"query","required":false,"schema":{"$ref":"#/components/schemas/FolderType","description":" *- example: QR_CODE*"},"description":" *- example: QR_CODE*"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size","default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_FolderListDetailResponse_"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Folders"],"summary":"Create a Folder","description":"Create a folder to house either your QR codes or Landing Pages.","operationId":"create_folder","security":[{"HTTPBearer":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderCreateRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderCreateResponse"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/folders/{folder_id}":{"get":{"tags":["Folders"],"summary":"Get a folder","description":"Returns a single folder by its unique identifier.","operationId":"get_folder","security":[{"HTTPBearer":[]}],"parameters":[{"name":"folder_id","in":"path","required":true,"schema":{"type":"string","description":"Unique identifier of a folder. *- example: 12345*","title":"Folder Id"},"description":"Unique identifier of a folder. *- example: 12345*"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderDetailResponse"}}}},"404":{"description":"folder not found","content":{"application/json":{"example":{"detail":"folder not found"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Folders"],"summary":"Delete a folder","description":"Deletes a folder.","operationId":"delete_folder","security":[{"HTTPBearer":[]}],"parameters":[{"name":"folder_id","in":"path","required":true,"schema":{"type":"string","description":"Unique identifier of a folder. *- example: 12345*","title":"Folder Id"},"description":"Unique identifier of a folder. *- example: 12345*"}],"responses":{"204":{"description":"No content - deletion successful"},"404":{"description":"folder not found","content":{"application/json":{"example":{"detail":"QR code not found"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/folders/{folder_id}/stats":{"get":{"tags":["Folders","Analytics"],"summary":"Get the statistics of a folder","description":"Get the folder statistics identified by its folder id.","operationId":"get_folder_stats","security":[{"HTTPBearer":[]}],"parameters":[{"name":"folder_id","in":"path","required":true,"schema":{"type":"string","description":"Unique identifier of a folder. *- example: 12345*","title":"Folder Id"},"description":"Unique identifier of a folder. *- example: 12345*"},{"name":"country_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by country code (exact match) *- example: DE*","title":"Country Code"},"description":"Filter by country code (exact match) *- example: DE*"},{"name":"scan_date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Filter scans of QR codes in folder from this date (inclusive) *- example: 2025-09-27*","title":"Scan Date From"},"description":"Filter scans of QR codes in folder from this date (inclusive) *- example: 2025-09-27*"},{"name":"scan_date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"Filter scans of QR codes in folder up to this date (inclusive) *- example: 2025-09-30*","title":"Scan Date To"},"description":"Filter scans of QR codes in folder up to this date (inclusive) *- example: 2025-09-30*"},{"name":"scan_date_relative_range","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/DateRelativeRange"},{"type":"null"}],"description":"Filter scans of QR codes in the folder via a relative day range selector","title":"Scan Date Relative Range"},"description":"Filter scans of QR codes in the folder via a relative day range selector"},{"name":"sort_order","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/SortOrder"},{"type":"null"}],"description":"Sort the result by scan date ascending or descending","title":"Sort Order"},"description":"Sort the result by scan date ascending or descending"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/app__api__v2__schemas__folders__ScanStatSummary"}}}},"404":{"description":"folder not found","content":{"application/json":{"example":{"detail":"folder not found"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/folders/{folder_id}/stats/reset":{"post":{"tags":["Folders","Analytics"],"summary":"Resets the statistics of a folder","description":"Resets the QR Code statistics of all QR codes in a folder.","operationId":"reset_folder_stats","security":[{"HTTPBearer":[]}],"parameters":[{"name":"folder_id","in":"path","required":true,"schema":{"type":"string","description":"Unique identifier of a folder. *- example: 12345*","title":"Folder Id"},"description":"Unique identifier of a folder. *- example: 12345*"}],"responses":{"204":{"description":"No content - resest successful"},"404":{"description":"folder not found","content":{"application/json":{"example":{"detail":"folder not found"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/designer-templates":{"get":{"tags":["Designer Templates"],"summary":"List Designer Templates","description":"Returns a paginated list of your Designer Templates to be used to generate Designer QR codes in /download-image/designer.","operationId":"list_designer_templates","security":[{"HTTPBearer":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size","default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_DesignerTemplateListDetailResponse_"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/designer-templates/{designer_template_id}":{"get":{"tags":["Designer Templates"],"summary":"Get a designer template","description":"Returns a single designer template by its unique identifier.","operationId":"get_designer_template","security":[{"HTTPBearer":[]}],"parameters":[{"name":"designer_template_id","in":"path","required":true,"schema":{"type":"string","description":"Unique identifier of a designer template. *- example: 42f88fb1de80ca479f87942c23ea74be*","title":"Designer Template Id"},"description":"Unique identifier of a designer template. *- example: 42f88fb1de80ca479f87942c23ea74be*"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DesignerTemplateDetailResponse"}}}},"404":{"description":"designer template not found","content":{"application/json":{"example":{"detail":"designer template not found"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/business-cards":{"get":{"tags":["Digital Business Cards"],"summary":"List Digital Business Cards","description":"Returns a paginated list of **Digital Business Cards** in your account.\n\n**Pagination:** uses `page` and `size`.","operationId":"list_bcards","security":[{"HTTPBearer":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size","default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_BusinessCardListResponse_"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl \\\n -X GET \\\n --max-time 10 \\\n -H 'Authorization: Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY' \\\n 'https://api.qrplanet.com/api/v2/business-cards?page=1'\n"},{"lang":"python","source":"# pip install requests\nimport requests\n\nurl = 'https://api.qrplanet.com/api/v2/business-cards'\nheaders = {'Authorization': 'Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY'}\nparams = {'page': 1}\n\ntimeout_seconds = 10\n\nr = requests.request('GET', url, headers=headers, params=params, timeout=timeout_seconds)\n\nprint(r.status_code)\n\ntry:\n data = r.json() # dict/list if response is JSON\n print(data)\nexcept ValueError:\n print(r.text)"},{"lang":"php","source":" 1];\n$query = http_build_query($params);\n$url = $query ? ($url . '?' . $query) : $url;\n\n$headers = ['Authorization: Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY'];\n\n$ch = curl_init($url);\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\ncurl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');\ncurl_setopt($ch, CURLOPT_HTTPHEADER, $headers);\ncurl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 10);\ncurl_setopt($ch, CURLOPT_TIMEOUT, 10);\n\n$resp = curl_exec($ch);\n$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);\ncurl_close($ch);\n\necho $status . \"\\n\";\n\n$data = json_decode($resp, true); // assoc array if JSON\nif (json_last_error() === JSON_ERROR_NONE) {\n print_r($data);\n} else {\n echo $resp . \"\\n\";\n}\n?>"},{"lang":"go","source":"package main\n\nimport (\n \"fmt\"\n \"io\"\n \"net/http\"\n \"net/url\"\n \"time\"\n \"encoding/json\"\n)\n\nfunc main() {\n baseURL := \"https://api.qrplanet.com/api/v2/business-cards\"\n u, err := url.Parse(baseURL)\n if err != nil {\n panic(err)\n }\n\n q := u.Query()\n q.Set(\"page\", \"1\")\n u.RawQuery = q.Encode()\n\n timeout := 10 * time.Second\n client := &http.Client{Timeout: timeout}\n\n var body io.Reader = nil\n\n req, err := http.NewRequest(\"GET\", u.String(), body)\n if err != nil {\n panic(err)\n }\n\n req.Header.Set(\"Authorization\", \"Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY\")\n\n resp, err := client.Do(req)\n if err != nil {\n panic(err)\n }\n defer resp.Body.Close()\n\n fmt.Println(resp.StatusCode)\n\n b, err := io.ReadAll(resp.Body)\n if err != nil {\n panic(err)\n }\n\n var data any\n if err := json.Unmarshal(b, &data); err == nil {\n pretty, _ := json.MarshalIndent(data, \"\", \" \")\n fmt.Println(string(pretty))\n } else {\n fmt.Println(string(b))\n }\n}"}]},"post":{"tags":["Digital Business Cards"],"summary":"Create a Digital Business Card","description":"Creates a Digital Business Card.","operationId":"create_bcard","security":[{"HTTPBearer":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCardCreateRequest"}}}},"responses":{"201":{"description":"CREATED","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCardGetResponse"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl \\\n -X POST \\\n --max-time 10 \\\n -H 'Authorization: Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mode\": \"BCARD\"\n}' \\\n 'https://api.qrplanet.com/api/v2/business-cards'\n"},{"lang":"python","source":"# pip install requests\nimport requests\n\nurl = 'https://api.qrplanet.com/api/v2/business-cards'\nheaders = {'Authorization': 'Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY', 'Content-Type': 'application/json'}\nparams = None\n\ntimeout_seconds = 10\n\njson_body = {'mode': 'BCARD', 'first_name': 'John', 'last_name': 'Doe'}\n\nr = requests.request('POST', url, headers=headers, params=params, json=json_body, timeout=timeout_seconds)\n\nprint(r.status_code)\n\ntry:\n data = r.json() # dict/list if response is JSON\n print(data)\nexcept ValueError:\n print(r.text)"},{"lang":"php","source":""},{"lang":"go","source":"package main\n\nimport (\n \"fmt\"\n \"io\"\n \"net/http\"\n \"net/url\"\n \"time\"\n \"strings\"\n \"encoding/json\"\n)\n\nfunc main() {\n baseURL := \"https://api.qrplanet.com/api/v2/business-cards\"\n u, err := url.Parse(baseURL)\n if err != nil {\n panic(err)\n }\n\n timeout := 10 * time.Second\n client := &http.Client{Timeout: timeout}\n\n var body io.Reader = nil\n body = strings.NewReader(`{\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"mode\": \"BCARD\"\n}`)\n\n req, err := http.NewRequest(\"POST\", u.String(), body)\n if err != nil {\n panic(err)\n }\n\n req.Header.Set(\"Authorization\", \"Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY\")\n req.Header.Set(\"Content-Type\", \"application/json\")\n\n resp, err := client.Do(req)\n if err != nil {\n panic(err)\n }\n defer resp.Body.Close()\n\n fmt.Println(resp.StatusCode)\n\n b, err := io.ReadAll(resp.Body)\n if err != nil {\n panic(err)\n }\n\n var data any\n if err := json.Unmarshal(b, &data); err == nil {\n pretty, _ := json.MarshalIndent(data, \"\", \" \")\n fmt.Println(string(pretty))\n } else {\n fmt.Println(string(b))\n }\n}"}]}},"/api/v2/business-cards/{code}":{"get":{"tags":["Digital Business Cards"],"summary":"Get a Digital Business Card","description":"Returns a single Digital Business Card by its unique identifier.","operationId":"get_bcard","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code that identifies a QR code of a Business Card. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. *- example: doe-john*","title":"Code"},"description":"Code that identifies a QR code of a Business Card. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. *- example: doe-john*"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCardGetResponse"}}}},"404":{"description":"QR code not found","content":{"application/json":{"example":{"detail":"QR code not found"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl \\\n -X GET \\\n --max-time 10 \\\n -H 'Authorization: Bearer public:YOURDOMAIN.COM:XXXXXXX:YYYYYYY' \\\n 'https://api.qrplanet.com/api/v2/bcards/doe-john'\n"},{"lang":"python","source":"# pip install requests\nimport requests\n\nurl = 'https://api.qrplanet.com/api/v2/bcards/doe-john'\nheaders = {'Authorization': 'Bearer public:YOURDOMAIN.COM:XXXXXXX:YYYYYYY'}\nparams = None\n\ntimeout_seconds = 10\n\nr = requests.request('GET', url, headers=headers, params=params, timeout=timeout_seconds)\n\nprint(r.status_code)\n\ntry:\n data = r.json() # dict/list if response is JSON\n print(data)\nexcept ValueError:\n print(r.text)"},{"lang":"php","source":""},{"lang":"go","source":"package main\n\nimport (\n \"fmt\"\n \"io\"\n \"net/http\"\n \"net/url\"\n \"time\"\n \"encoding/json\"\n)\n\nfunc main() {\n baseURL := \"https://api.qrplanet.com/api/v2/bcards/doe-john\"\n u, err := url.Parse(baseURL)\n if err != nil {\n panic(err)\n }\n\n timeout := 10 * time.Second\n client := &http.Client{Timeout: timeout}\n\n var body io.Reader = nil\n\n req, err := http.NewRequest(\"GET\", u.String(), body)\n if err != nil {\n panic(err)\n }\n\n req.Header.Set(\"Authorization\", \"Bearer public:YOURDOMAIN.COM:XXXXXXX:YYYYYYY\")\n\n resp, err := client.Do(req)\n if err != nil {\n panic(err)\n }\n defer resp.Body.Close()\n\n fmt.Println(resp.StatusCode)\n\n b, err := io.ReadAll(resp.Body)\n if err != nil {\n panic(err)\n }\n\n var data any\n if err := json.Unmarshal(b, &data); err == nil {\n pretty, _ := json.MarshalIndent(data, \"\", \" \")\n fmt.Println(string(pretty))\n } else {\n fmt.Println(string(b))\n }\n}"}]},"patch":{"tags":["Digital Business Cards"],"summary":"Change certain fields of a Digital Business Card","description":"Change certain fields of a Digital Business Card identified by its code.","operationId":"change_bcard","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code that identifies a QR code of a Business Card. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. *- example: doe-john*","title":"Code"},"description":"Code that identifies a QR code of a Business Card. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. *- example: doe-john*"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCardPatchRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCardGetResponse"}}}},"404":{"description":"QR code not found","content":{"application/json":{"example":{"detail":"QR code not found"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl \\\n -X PATCH \\\n --max-time 10 \\\n -H 'Authorization: Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"company\": \"My New Company\",\n \"company_url\": \"https://newcompany.com\"\n}' \\\n 'https://api.qrplanet.com/api/v2/business-cards/doe-john'\n"},{"lang":"python","source":"# pip install requests\nimport requests\n\nurl = 'https://api.qrplanet.com/api/v2/business-cards/doe-john'\nheaders = {'Authorization': 'Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY', 'Content-Type': 'application/json'}\nparams = None\n\ntimeout_seconds = 10\n\njson_body = {'company': 'My New Company', 'company_url': 'https://newcompany.com'}\n\nr = requests.request('PATCH', url, headers=headers, params=params, json=json_body, timeout=timeout_seconds)\n\nprint(r.status_code)\n\ntry:\n data = r.json() # dict/list if response is JSON\n print(data)\nexcept ValueError:\n print(r.text)"},{"lang":"php","source":""},{"lang":"go","source":"package main\n\nimport (\n \"fmt\"\n \"io\"\n \"net/http\"\n \"net/url\"\n \"time\"\n \"strings\"\n \"encoding/json\"\n)\n\nfunc main() {\n baseURL := \"https://api.qrplanet.com/api/v2/business-cards/doe-john\"\n u, err := url.Parse(baseURL)\n if err != nil {\n panic(err)\n }\n\n timeout := 10 * time.Second\n client := &http.Client{Timeout: timeout}\n\n var body io.Reader = nil\n body = strings.NewReader(`{\n \"company\": \"My New Company\",\n \"company_url\": \"https://newcompany.com\"\n}`)\n\n req, err := http.NewRequest(\"PATCH\", u.String(), body)\n if err != nil {\n panic(err)\n }\n\n req.Header.Set(\"Authorization\", \"Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY\")\n req.Header.Set(\"Content-Type\", \"application/json\")\n\n resp, err := client.Do(req)\n if err != nil {\n panic(err)\n }\n defer resp.Body.Close()\n\n fmt.Println(resp.StatusCode)\n\n b, err := io.ReadAll(resp.Body)\n if err != nil {\n panic(err)\n }\n\n var data any\n if err := json.Unmarshal(b, &data); err == nil {\n pretty, _ := json.MarshalIndent(data, \"\", \" \")\n fmt.Println(string(pretty))\n } else {\n fmt.Println(string(b))\n }\n}"}]},"delete":{"tags":["Digital Business Cards"],"summary":"Delete a Digital Business Card","description":"Delete a Digital Business Card identified by its code.","operationId":"delete_bcard","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code that identifies a QR code of a Business Card. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. *- example: doe-john*","title":"Code"},"description":"Code that identifies a QR code of a Business Card. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. *- example: doe-john*"}],"responses":{"204":{"description":"No content - deletion successful"},"404":{"description":"QR code not found","content":{"application/json":{"example":{"detail":"QR code not found"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl \\\n -X DELETE \\\n --max-time 10 \\\n -H 'Authorization: Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY' \\\n 'https://api.qrplanet.com/api/v2/business-cards/doe-john'\n"},{"lang":"python","source":"# pip install requests\nimport requests\n\nurl = 'https://api.qrplanet.com/api/v2/business-cards/doe-john'\nheaders = {'Authorization': 'Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY'}\nparams = None\n\ntimeout_seconds = 10\n\nr = requests.request('DELETE', url, headers=headers, params=params, timeout=timeout_seconds)\n\nprint(r.status_code)\n\ntry:\n data = r.json() # dict/list if response is JSON\n print(data)\nexcept ValueError:\n print(r.text)"},{"lang":"php","source":""},{"lang":"go","source":"package main\n\nimport (\n \"fmt\"\n \"io\"\n \"net/http\"\n \"net/url\"\n \"time\"\n \"encoding/json\"\n)\n\nfunc main() {\n baseURL := \"https://api.qrplanet.com/api/v2/business-cards/doe-john\"\n u, err := url.Parse(baseURL)\n if err != nil {\n panic(err)\n }\n\n timeout := 10 * time.Second\n client := &http.Client{Timeout: timeout}\n\n var body io.Reader = nil\n\n req, err := http.NewRequest(\"DELETE\", u.String(), body)\n if err != nil {\n panic(err)\n }\n\n req.Header.Set(\"Authorization\", \"Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY\")\n\n resp, err := client.Do(req)\n if err != nil {\n panic(err)\n }\n defer resp.Body.Close()\n\n fmt.Println(resp.StatusCode)\n\n b, err := io.ReadAll(resp.Body)\n if err != nil {\n panic(err)\n }\n\n var data any\n if err := json.Unmarshal(b, &data); err == nil {\n pretty, _ := json.MarshalIndent(data, \"\", \" \")\n fmt.Println(string(pretty))\n } else {\n fmt.Println(string(b))\n }\n}"}]}},"/api/v2/business-cards/{code}/images/{kind}":{"post":{"tags":["Digital Business Cards"],"summary":"Upload an image for a Digital Business Card","description":"Uploads an image for an existing Digital Business Card.\nCan be a user image, logo image or background image (kind).\nOnly JPEG, PNG, and GIF images are supported.\n\n\ncURL:\n\n```bash\nCODE=\"YOUR_CODE\"\nAPI_KEY=\"YOUR_SECRET_API_KEY\"\n\ncurl -X POST \"https://api.qrplanet.com/api/v2/business-cards/${CODE}/images/USER\" -H \"Authorization: Bearer ${API_KEY}\" -F \"image=@avatar.jpg;type=image/jpeg;filename=user.jpg\"\n```\n\nPHP:\n\n```php\n $cfile\n);\n\n$ch = curl_init();\ncurl_setopt($ch, CURLOPT_URL, $target_url);\ncurl_setopt($ch, CURLOPT_POST, 1);\ncurl_setopt($ch, CURLOPT_HEADER, 0);\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);\ncurl_setopt($ch, CURLOPT_POSTFIELDS, $post);\ncurl_setopt($ch, CURLOPT_HTTPHEADER, array(\n \"Authorization: Bearer $apiKey\"\n));\n\n$result = curl_exec($ch);\n\nif ($result === FALSE) {\n echo \"Upload error: \" . curl_error($ch);\n curl_close($ch);\n} else {\n $http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);\n curl_close($ch);\n echo \"HTTP $http_code\nResult:\n$result\";\n}\n\n```\n\nPython:\n\n```python\nimport os\nimport requests\n\n# -------------------------\n# CONFIG\n# -------------------------\ncode = \"YOUR_CODE\"\napi_key = \"YOUR_SECRET_API_KEY\"\n\ntarget_url = f\"https://api.qrplanet.com/api/v2/business-cards/{code}/images/USER\"\n\nfname = \"avatar.jpg\"\n\n# -------------------------\n# CHECK FILE\n# -------------------------\nif not os.path.isfile(fname):\n print(f\"The file {fname} does not exist. Current dir: {os.getcwd()}\")\n raise SystemExit(1)\n\n# -------------------------\n# MULTIPART UPLOAD\n# -------------------------\nwith open(fname, \"rb\") as f:\n files = {\n \"image\": (\"user.jpg\", f, \"image/jpeg\") # matches PHP CURLFile\n }\n\n headers = {\n \"Authorization\": f\"Bearer {api_key}\"\n }\n\n response = requests.post(target_url, files=files, headers=headers)\n\n# -------------------------\n# RESULT\n# -------------------------\nprint(\"HTTP\", response.status_code)\nprint(\"Result:\")\nprint(response.text)\n\n```","operationId":"upload_bcard_image","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code that identifies a QR code of a Business Card. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. *- example: doe-john*","title":"Code"},"description":"Code that identifies a QR code of a Business Card. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. *- example: doe-john*"},{"name":"kind","in":"path","required":true,"schema":{"$ref":"#/components/schemas/ImageKind","description":"Kind of image you want to upload (USER, LOGO, BACKGROUND) *- example: USER*"},"description":"Kind of image you want to upload (USER, LOGO, BACKGROUND) *- example: USER*"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_bcard_image"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessCardGetResponse"}}}},"404":{"description":"QR code not found","content":{"application/json":{"example":{"detail":"QR code not found"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/coupons":{"get":{"tags":["Coupons"],"summary":"List Coupons","description":"Returns a paginated list of **Coupons** in your account.\n\n**Pagination:** uses `page` and `size`.","operationId":"list_coupons","security":[{"HTTPBearer":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size","default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_CouponGetResponse_"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl \\\n -X GET \\\n --max-time 10 \\\n -H 'Authorization: Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY' \\\n 'https://api.qrplanet.com/api/v2/coupons'\n"},{"lang":"python","source":"# pip install requests\nimport requests\n\nurl = 'https://api.qrplanet.com/api/v2/coupons'\nheaders = {'Authorization': 'Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY'}\nparams = None\n\ntimeout_seconds = 10\n\nr = requests.request('GET', url, headers=headers, params=params, timeout=timeout_seconds)\n\nprint(r.status_code)\n\ntry:\n data = r.json() # dict/list if response is JSON\n print(data)\nexcept ValueError:\n print(r.text)"},{"lang":"php","source":""},{"lang":"go","source":"package main\n\nimport (\n \"fmt\"\n \"io\"\n \"net/http\"\n \"net/url\"\n \"time\"\n \"encoding/json\"\n)\n\nfunc main() {\n baseURL := \"https://api.qrplanet.com/api/v2/coupons\"\n u, err := url.Parse(baseURL)\n if err != nil {\n panic(err)\n }\n\n timeout := 10 * time.Second\n client := &http.Client{Timeout: timeout}\n\n var body io.Reader = nil\n\n req, err := http.NewRequest(\"GET\", u.String(), body)\n if err != nil {\n panic(err)\n }\n\n req.Header.Set(\"Authorization\", \"Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY\")\n\n resp, err := client.Do(req)\n if err != nil {\n panic(err)\n }\n defer resp.Body.Close()\n\n fmt.Println(resp.StatusCode)\n\n b, err := io.ReadAll(resp.Body)\n if err != nil {\n panic(err)\n }\n\n var data any\n if err := json.Unmarshal(b, &data); err == nil {\n pretty, _ := json.MarshalIndent(data, \"\", \" \")\n fmt.Println(string(pretty))\n } else {\n fmt.Println(string(b))\n }\n}"}]}},"/api/v2/coupons/{code}/issue-voucher":{"post":{"tags":["Coupons"],"summary":"Issue a voucher for a coupon","description":"Returns an issued voucher for a coupon.","operationId":"issue_voucher","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code that identifies a QR code of a Coupon. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. *- example: easter-promotion-coupon*","title":"Code"},"description":"Code that identifies a QR code of a Coupon. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. *- example: easter-promotion-coupon*"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueVoucherRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueVoucherResponse"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl \\\n -X POST \\\n --max-time 10 \\\n -H 'Authorization: Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"max_issues_per_unique_id\": 5,\n \"ttl\": 14\n}' \\\n 'https://api.qrplanet.com/api/v2/coupons/easter-promotion-coupon/issue-voucher'\n"},{"lang":"python","source":"# pip install requests\nimport requests\n\nurl = 'https://api.qrplanet.com/api/v2/coupons/easter-promotion-coupon/issue-voucher'\nheaders = {'Authorization': 'Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY', 'Content-Type': 'application/json'}\nparams = None\n\ntimeout_seconds = 10\n\njson_body = {'ttl': 14, 'max_issues_per_unique_id': 5}\n\nr = requests.request('POST', url, headers=headers, params=params, json=json_body, timeout=timeout_seconds)\n\nprint(r.status_code)\n\ntry:\n data = r.json() # dict/list if response is JSON\n print(data)\nexcept ValueError:\n print(r.text)"},{"lang":"php","source":""},{"lang":"go","source":"package main\n\nimport (\n \"fmt\"\n \"io\"\n \"net/http\"\n \"net/url\"\n \"time\"\n \"strings\"\n \"encoding/json\"\n)\n\nfunc main() {\n baseURL := \"https://api.qrplanet.com/api/v2/coupons/easter-promotion-coupon/issue-voucher\"\n u, err := url.Parse(baseURL)\n if err != nil {\n panic(err)\n }\n\n timeout := 10 * time.Second\n client := &http.Client{Timeout: timeout}\n\n var body io.Reader = nil\n body = strings.NewReader(`{\n \"max_issues_per_unique_id\": 5,\n \"ttl\": 14\n}`)\n\n req, err := http.NewRequest(\"POST\", u.String(), body)\n if err != nil {\n panic(err)\n }\n\n req.Header.Set(\"Authorization\", \"Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY\")\n req.Header.Set(\"Content-Type\", \"application/json\")\n\n resp, err := client.Do(req)\n if err != nil {\n panic(err)\n }\n defer resp.Body.Close()\n\n fmt.Println(resp.StatusCode)\n\n b, err := io.ReadAll(resp.Body)\n if err != nil {\n panic(err)\n }\n\n var data any\n if err := json.Unmarshal(b, &data); err == nil {\n pretty, _ := json.MarshalIndent(data, \"\", \" \")\n fmt.Println(string(pretty))\n } else {\n fmt.Println(string(b))\n }\n}"}]}},"/api/v2/coupons/{code}/stats":{"get":{"tags":["Coupons","Analytics"],"summary":"Get the Coupon Issue Statistics","description":"Returns the issue statistics of a Coupon.","operationId":"get_coupon_stats","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code that identifies a QR code of a Coupon. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. *- example: easter-promotion-coupon*","title":"Code"},"description":"Code that identifies a QR code of a Coupon. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. *- example: easter-promotion-coupon*"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssueStatisticsResponse"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl \\\n -X GET \\\n --max-time 10 \\\n -H 'Authorization: Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY' \\\n 'https://api.qrplanet.com/api/v2/coupons/easter-promotion-coupon/stats'\n"},{"lang":"python","source":"# pip install requests\nimport requests\n\nurl = 'https://api.qrplanet.com/api/v2/coupons/easter-promotion-coupon/stats'\nheaders = {'Authorization': 'Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY'}\nparams = None\n\ntimeout_seconds = 10\n\nr = requests.request('GET', url, headers=headers, params=params, timeout=timeout_seconds)\n\nprint(r.status_code)\n\ntry:\n data = r.json() # dict/list if response is JSON\n print(data)\nexcept ValueError:\n print(r.text)"},{"lang":"php","source":""},{"lang":"go","source":"package main\n\nimport (\n \"fmt\"\n \"io\"\n \"net/http\"\n \"net/url\"\n \"time\"\n \"encoding/json\"\n)\n\nfunc main() {\n baseURL := \"https://api.qrplanet.com/api/v2/coupons/easter-promotion-coupon/stats\"\n u, err := url.Parse(baseURL)\n if err != nil {\n panic(err)\n }\n\n timeout := 10 * time.Second\n client := &http.Client{Timeout: timeout}\n\n var body io.Reader = nil\n\n req, err := http.NewRequest(\"GET\", u.String(), body)\n if err != nil {\n panic(err)\n }\n\n req.Header.Set(\"Authorization\", \"Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY\")\n\n resp, err := client.Do(req)\n if err != nil {\n panic(err)\n }\n defer resp.Body.Close()\n\n fmt.Println(resp.StatusCode)\n\n b, err := io.ReadAll(resp.Body)\n if err != nil {\n panic(err)\n }\n\n var data any\n if err := json.Unmarshal(b, &data); err == nil {\n pretty, _ := json.MarshalIndent(data, \"\", \" \")\n fmt.Println(string(pretty))\n } else {\n fmt.Println(string(b))\n }\n}"}]}},"/api/v2/coupons/{code}/redemptions":{"get":{"tags":["Coupons","Analytics"],"summary":"Get the Coupon Redemption/Redeem Statistics","description":"Returns the redemption statistics of a Coupon.","operationId":"get_coupon_redemptions","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code that identifies a QR code of a Coupon. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. *- example: easter-promotion-coupon*","title":"Code"},"description":"Code that identifies a QR code of a Coupon. Its usually the slug of the QR code that you either provided during QR code creation or that got automatically assigned to if not provided by you. *- example: easter-promotion-coupon*"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size","default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_IssueRedemptionsResponse_"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl \\\n -X GET \\\n --max-time 10 \\\n -H 'Authorization: Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY' \\\n 'https://api.qrplanet.com/api/v2/coupons/easter-promotion-coupon/redemptions'\n"},{"lang":"python","source":"# pip install requests\nimport requests\n\nurl = 'https://api.qrplanet.com/api/v2/coupons/easter-promotion-coupon/redemptions'\nheaders = {'Authorization': 'Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY'}\nparams = None\n\ntimeout_seconds = 10\n\nr = requests.request('GET', url, headers=headers, params=params, timeout=timeout_seconds)\n\nprint(r.status_code)\n\ntry:\n data = r.json() # dict/list if response is JSON\n print(data)\nexcept ValueError:\n print(r.text)"},{"lang":"php","source":""},{"lang":"go","source":"package main\n\nimport (\n \"fmt\"\n \"io\"\n \"net/http\"\n \"net/url\"\n \"time\"\n \"encoding/json\"\n)\n\nfunc main() {\n baseURL := \"https://api.qrplanet.com/api/v2/coupons/easter-promotion-coupon/redemptions\"\n u, err := url.Parse(baseURL)\n if err != nil {\n panic(err)\n }\n\n timeout := 10 * time.Second\n client := &http.Client{Timeout: timeout}\n\n var body io.Reader = nil\n\n req, err := http.NewRequest(\"GET\", u.String(), body)\n if err != nil {\n panic(err)\n }\n\n req.Header.Set(\"Authorization\", \"Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY\")\n\n resp, err := client.Do(req)\n if err != nil {\n panic(err)\n }\n defer resp.Body.Close()\n\n fmt.Println(resp.StatusCode)\n\n b, err := io.ReadAll(resp.Body)\n if err != nil {\n panic(err)\n }\n\n var data any\n if err := json.Unmarshal(b, &data); err == nil {\n pretty, _ := json.MarshalIndent(data, \"\", \" \")\n fmt.Println(string(pretty))\n } else {\n fmt.Println(string(b))\n }\n}"}]}},"/api/v2/gs1-digital-link":{"post":{"tags":["GS1 Digital Link"],"summary":"Create a GS1 Digital Link QR Code","description":"Creates a GS1 Digital Link QR Code.","operationId":"create_gs1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GS1CreateRequest"}}},"required":true},"responses":{"201":{"description":"CREATED","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GS1CreateResponse"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}],"x-codeSamples":[{"lang":"curl","source":"curl \\\n -X POST \\\n --max-time 10 \\\n -H 'Authorization: Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"batch_number\": \"L2401A9\",\n \"primary_key_value\": \"5449000297280\",\n \"target_url\": \"https://www.coca-cola.com/ca/en/brands/coca-cola/products/coca-cola-original-taste\",\n \"title\": \"Coca-Cola Original Taste 500 ml Bottle\"\n}' \\\n 'https://api.qrplanet.com/api/v2/gs1-digital-link'\n"},{"lang":"python","source":"# pip install requests\nimport requests\n\nurl = 'https://api.qrplanet.com/api/v2/gs1-digital-link'\nheaders = {'Authorization': 'Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY', 'Content-Type': 'application/json'}\nparams = None\n\ntimeout_seconds = 10\n\njson_body = {'primary_key_value': '5449000297280', 'target_url': 'https://www.coca-cola.com/ca/en/brands/coca-cola/products/coca-cola-original-taste', 'title': 'Coca-Cola Original Taste 500 ml Bottle', 'batch_number': 'L2401A9'}\n\nr = requests.request('POST', url, headers=headers, params=params, json=json_body, timeout=timeout_seconds)\n\nprint(r.status_code)\n\ntry:\n data = r.json() # dict/list if response is JSON\n print(data)\nexcept ValueError:\n print(r.text)"},{"lang":"php","source":""},{"lang":"go","source":"package main\n\nimport (\n \"fmt\"\n \"io\"\n \"net/http\"\n \"net/url\"\n \"time\"\n \"strings\"\n \"encoding/json\"\n)\n\nfunc main() {\n baseURL := \"https://api.qrplanet.com/api/v2/gs1-digital-link\"\n u, err := url.Parse(baseURL)\n if err != nil {\n panic(err)\n }\n\n timeout := 10 * time.Second\n client := &http.Client{Timeout: timeout}\n\n var body io.Reader = nil\n body = strings.NewReader(`{\n \"batch_number\": \"L2401A9\",\n \"primary_key_value\": \"5449000297280\",\n \"target_url\": \"https://www.coca-cola.com/ca/en/brands/coca-cola/products/coca-cola-original-taste\",\n \"title\": \"Coca-Cola Original Taste 500 ml Bottle\"\n}`)\n\n req, err := http.NewRequest(\"POST\", u.String(), body)\n if err != nil {\n panic(err)\n }\n\n req.Header.Set(\"Authorization\", \"Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY\")\n req.Header.Set(\"Content-Type\", \"application/json\")\n\n resp, err := client.Do(req)\n if err != nil {\n panic(err)\n }\n defer resp.Body.Close()\n\n fmt.Println(resp.StatusCode)\n\n b, err := io.ReadAll(resp.Body)\n if err != nil {\n panic(err)\n }\n\n var data any\n if err := json.Unmarshal(b, &data); err == nil {\n pretty, _ := json.MarshalIndent(data, \"\", \" \")\n fmt.Println(string(pretty))\n } else {\n fmt.Println(string(b))\n }\n}"}]}},"/api/v2/gs1-digital-link/{code}/rules":{"get":{"tags":["GS1 Digital Link"],"summary":"List Rules of a GS1 Digital Link","description":"Returns a paginated list of Rules of a GS1 Digital Link.","operationId":"list_rules","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code that identifies a QR code of a GS1 Digital Link. Its got automatically assigned during creation. *- example: 913e39f179f883d36c2eb6f99ac20b99*","title":"Code"},"description":"Code that identifies a QR code of a GS1 Digital Link. Its got automatically assigned during creation. *- example: 913e39f179f883d36c2eb6f99ac20b99*"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size","default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_GS1GetRuleResponse_"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl \\\n -X GET \\\n --max-time 10 \\\n -H 'Authorization: Bearer public:YOURDOMAIN.COM:XXXXXXX:YYYYYYY' \\\n 'https://api.qrplanet.com/api/v2/gs1-digital-link/913e39f179f883d36c2eb6f99ac20b99/rules'\n"},{"lang":"python","source":"# pip install requests\nimport requests\n\nurl = 'https://api.qrplanet.com/api/v2/gs1-digital-link/913e39f179f883d36c2eb6f99ac20b99/rules'\nheaders = {'Authorization': 'Bearer public:YOURDOMAIN.COM:XXXXXXX:YYYYYYY'}\nparams = None\n\ntimeout_seconds = 10\n\nr = requests.request('GET', url, headers=headers, params=params, timeout=timeout_seconds)\n\nprint(r.status_code)\n\ntry:\n data = r.json() # dict/list if response is JSON\n print(data)\nexcept ValueError:\n print(r.text)"},{"lang":"php","source":""},{"lang":"go","source":"package main\n\nimport (\n \"fmt\"\n \"io\"\n \"net/http\"\n \"net/url\"\n \"time\"\n \"encoding/json\"\n)\n\nfunc main() {\n baseURL := \"https://api.qrplanet.com/api/v2/gs1-digital-link/913e39f179f883d36c2eb6f99ac20b99/rules\"\n u, err := url.Parse(baseURL)\n if err != nil {\n panic(err)\n }\n\n timeout := 10 * time.Second\n client := &http.Client{Timeout: timeout}\n\n var body io.Reader = nil\n\n req, err := http.NewRequest(\"GET\", u.String(), body)\n if err != nil {\n panic(err)\n }\n\n req.Header.Set(\"Authorization\", \"Bearer public:YOURDOMAIN.COM:XXXXXXX:YYYYYYY\")\n\n resp, err := client.Do(req)\n if err != nil {\n panic(err)\n }\n defer resp.Body.Close()\n\n fmt.Println(resp.StatusCode)\n\n b, err := io.ReadAll(resp.Body)\n if err != nil {\n panic(err)\n }\n\n var data any\n if err := json.Unmarshal(b, &data); err == nil {\n pretty, _ := json.MarshalIndent(data, \"\", \" \")\n fmt.Println(string(pretty))\n } else {\n fmt.Println(string(b))\n }\n}"}]},"post":{"tags":["GS1 Digital Link"],"summary":"Create a Rule for a GS1 Digital Link QR Code","description":"This API call adds a rule to a GS1 Digital Link QR Code based on LinkTypes/Languages.\n\nThe following logic applies for Rules:\n\n- If a Rule matches then the user gets redirected to the `target_url` that is specified in that Rule.\n- If no Rule matches then the `default_target_url` from the creation of the GS1 Digital Link QR Code is going to be used.\n\nExample - The following Rules are specified:\n\n- Rule A: `gs1:pip`/`de` -> Link to German Coca Cola Product Page\n- Rule B: `gs1:pip`/`NO_LANGUAGE` (=all other languages) -> Link to international Coca Cola Product Page\n- Rule C: `gs1:faqs`/`es`, `pt` -> Link to Spanish FAQ (Frequently Asked Questions) Page\n- Rule D: `gs1:relatedVideo`/`de` -> Link to German YouTue Video about the Coca Cola Bottle\n\nUser with the following combination of requested LinkType and Browser Language scans the GS1 Digital Link:\n\n⬇️-LinkType / Browser-Language-➡️|DE|EN|ES\n---|---|---|---\ngs1:pip|Rule A matches|Rule B matches|Rule B matches\ngs1:relatedVideo|Rule D matches|No Rule matches -> Default Target URL|No Rule matches -> Default Target URL\ngs1:faqs|No Rule matches -> Default Target URL|No Rule matches -> Default Target URL|Rule C matches\ngs1:careersInfo|No Rule matches -> Default Target URL|No Rule matches -> Default Target URL|No Rule matches -> Default Target URL","operationId":"create_gs1_rule","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code that identifies a QR code of a GS1 Digital Link. Its got automatically assigned during creation. *- example: 913e39f179f883d36c2eb6f99ac20b99*","title":"Code"},"description":"Code that identifies a QR code of a GS1 Digital Link. Its got automatically assigned during creation. *- example: 913e39f179f883d36c2eb6f99ac20b99*"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GS1CreateRuleRequest"}}}},"responses":{"201":{"description":"CREATED","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GS1CreateRuleResponse"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl \\\n -X POST \\\n --max-time 10 \\\n -H 'Authorization: Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{}' \\\n 'https://api.qrplanet.com/api/v2/gs1-digital-link/rules'\n"},{"lang":"python","source":"# pip install requests\nimport requests\n\nurl = 'https://api.qrplanet.com/api/v2/gs1-digital-link/rules'\nheaders = {'Authorization': 'Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY', 'Content-Type': 'application/json'}\nparams = None\n\ntimeout_seconds = 10\n\njson_body = {}\n\nr = requests.request('POST', url, headers=headers, params=params, json=json_body, timeout=timeout_seconds)\n\nprint(r.status_code)\n\ntry:\n data = r.json() # dict/list if response is JSON\n print(data)\nexcept ValueError:\n print(r.text)"},{"lang":"php","source":""},{"lang":"go","source":"package main\n\nimport (\n \"fmt\"\n \"io\"\n \"net/http\"\n \"net/url\"\n \"time\"\n \"strings\"\n \"encoding/json\"\n)\n\nfunc main() {\n baseURL := \"https://api.qrplanet.com/api/v2/gs1-digital-link/rules\"\n u, err := url.Parse(baseURL)\n if err != nil {\n panic(err)\n }\n\n timeout := 10 * time.Second\n client := &http.Client{Timeout: timeout}\n\n var body io.Reader = nil\n body = strings.NewReader(`{}`)\n\n req, err := http.NewRequest(\"POST\", u.String(), body)\n if err != nil {\n panic(err)\n }\n\n req.Header.Set(\"Authorization\", \"Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY\")\n req.Header.Set(\"Content-Type\", \"application/json\")\n\n resp, err := client.Do(req)\n if err != nil {\n panic(err)\n }\n defer resp.Body.Close()\n\n fmt.Println(resp.StatusCode)\n\n b, err := io.ReadAll(resp.Body)\n if err != nil {\n panic(err)\n }\n\n var data any\n if err := json.Unmarshal(b, &data); err == nil {\n pretty, _ := json.MarshalIndent(data, \"\", \" \")\n fmt.Println(string(pretty))\n } else {\n fmt.Println(string(b))\n }\n}"}]},"delete":{"tags":["GS1 Digital Link"],"summary":"Delete all Rules of a GS1 Digital Link","description":"Deletes all Rules of a GS1 Digital Link identified by its code.","operationId":"gs1_delete_rules","security":[{"HTTPBearer":[]}],"parameters":[{"name":"code","in":"path","required":true,"schema":{"type":"string","description":"Code that identifies a QR code of a GS1 Digital Link. Its got automatically assigned during creation. *- example: 913e39f179f883d36c2eb6f99ac20b99*","title":"Code"},"description":"Code that identifies a QR code of a GS1 Digital Link. Its got automatically assigned during creation. *- example: 913e39f179f883d36c2eb6f99ac20b99*"}],"responses":{"204":{"description":"No content - deletion successful"},"404":{"description":"QR code not found","content":{"application/json":{"example":{"detail":"QR code not found"}}}},"401":{"description":"Authentication failed - invalid or missing credentials","content":{"application/json":{"example":{"detail":"Invalid authentication token"}}}},"403":{"description":"Permission denied - you don't have access to this resource","content":{"application/json":{"example":{"detail":"Permission denied"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"x-codeSamples":[{"lang":"curl","source":"curl \\\n -X DELETE \\\n --max-time 10 \\\n -H 'Authorization: Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{}' \\\n 'https://api.qrplanet.com/api/v2/gs1-digital-link/913e39f179f883d36c2eb6f99ac20b99/rules'"},{"lang":"python","source":"# pip install requests\nimport requests\n\nurl = 'https://api.qrplanet.com/api/v2/gs1-digital-link/913e39f179f883d36c2eb6f99ac20b99/rules'\nheaders = {'Authorization': 'Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY', 'Content-Type': 'application/json'}\nparams = None\n\ntimeout_seconds = 10\n\njson_body = {}\n\nr = requests.request('DELETE', url, headers=headers, params=params, json=json_body, timeout=timeout_seconds)\n\nprint(r.status_code)\n\nprint(r.status_code)\nprint(r.text) # for binary/file endpoints, handle r.content instead"},{"lang":"php","source":""},{"lang":"go","source":"package main\n\nimport (\n \"fmt\"\n \"io\"\n \"net/http\"\n \"net/url\"\n \"time\"\n \"strings\"\n)\n\nfunc main() {\n baseURL := \"https://api.qrplanet.com/api/v2/gs1-digital-link/913e39f179f883d36c2eb6f99ac20b99/rules\"\n u, err := url.Parse(baseURL)\n if err != nil {\n panic(err)\n }\n\n timeout := 10 * time.Second\n client := &http.Client{Timeout: timeout}\n\n var body io.Reader = nil\n body = strings.NewReader(`{}`)\n\n req, err := http.NewRequest(\"DELETE\", u.String(), body)\n if err != nil {\n panic(err)\n }\n\n req.Header.Set(\"Authorization\", \"Bearer secret:YOURDOMAIN.COM:XXXXXXX:YYYYYYY\")\n req.Header.Set(\"Content-Type\", \"application/json\")\n\n resp, err := client.Do(req)\n if err != nil {\n panic(err)\n }\n defer resp.Body.Close()\n\n fmt.Println(resp.StatusCode)\n\n b, err := io.ReadAll(resp.Body)\n if err != nil {\n panic(err)\n }\n\n fmt.Println(string(b))\n}"}]}},"/api/v2/health":{"get":{"tags":["Default"],"summary":"Health check","description":"Call this endpoint to check if the API is healthy","operationId":"health_api_v2_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthResponse"}}}}}}}},"components":{"schemas":{"Body_upload_bcard_image":{"properties":{"image":{"type":"string","format":"binary","title":"Image"}},"type":"object","required":["image"],"title":"Body_upload_bcard_image"},"BusinessCardCreateRequest":{"properties":{"slug":{"anyOf":[{"type":"string","maxLength":50,"minLength":3},{"type":"null"}],"title":"Slug","description":"An (optional) custom slug you want to use like doe-john which leads to a final Short URL like https://qr.yourdomain.com/doe-john (dependent on the domain you are using in your account). If not specified a combination of first and last name is being used for the Short URL. In the rest of the API you can access the Digital Business Card then via this slug in the `code` path parameter like GET /api/v2/business-cards/{code}. This is also sometimes referred to as Vanity URL in the frontend UI.","example":"doe-john"},"mode":{"anyOf":[{"$ref":"#/components/schemas/BusinessCardMode"},{"type":"null"}],"description":"The mode of the business card. It can be either a Business Card (BCARD) or a VCARD.","default":"BCARD","example":"BCARD"},"folder_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id","description":"The id of the folder you want the business card to be in (optional).\n- For a Business Card (BCARD) the folder needs to have the type `LANDING_PAGE`\n- For a VCARD the folder needs to have the type `QR_CODE`.","example":"BCARD"},"template_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Template Code","description":"The code of the Digital Business Card you want to use as a template for the created/updated Digital Business Card (optional).","example":"abc123"},"first_name":{"type":"string","title":"First Name","description":"The first name of the business card.","example":"John"},"last_name":{"type":"string","title":"Last Name","description":"The first name of the business card.","example":"Doe"},"job":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job","description":"The job of the business card (bcard job).","example":"Software Engineer"},"role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role","description":"The role of the business card (bcard role).","example":"Backend Developer"},"company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company","description":"The company name of the business card.","example":"Your Company Inc"},"company_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Url","description":"The URL of the website of the business card.","example":"https://yourcompany.com"},"department":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Department","description":"The department of the business card.","example":"IT"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"The email of the business card.","example":"john.doe@yourcompany.com"},"email_private":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email Private","description":"The private email of the business card.","example":"john.doe.private@yourcompany.com"},"street":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Street","description":"The street of the business card.","example":"Times Square 1"},"zip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zip","description":"The ZIP code of the business card.","example":"10036"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"The city of the business card.","example":"New York"},"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country Code","description":"The country code of the business card.","example":"USA"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"The state of the business card.","example":"NY"}},"type":"object","title":"BusinessCardCreateRequest"},"BusinessCardGetResponse":{"properties":{"code":{"type":"string","title":"Code","description":"The code of the QR code (either provided vanity code or randomly generated code if not provided).","example":"doe-john"},"full_name":{"type":"string","title":"Full Name","description":"The full name of the business card (bcard job).","example":"John Doe"},"first_name":{"type":"string","title":"First Name","description":"The first name of the business card.","example":"John"},"last_name":{"type":"string","title":"Last Name","description":"The first name of the business card.","example":"Doe"},"job":{"type":"string","title":"Job","description":"The job of the business card (bcard job).","example":"Software Engineer"},"role":{"type":"string","title":"Role","description":"The role of the business card (bcard role).","example":"Backend Developer"},"company":{"type":"string","title":"Company","description":"The company name of the business card.","example":"Your Company Inc"},"company_url":{"type":"string","title":"Company Url","description":"The URL of the website of the business card.","example":"https://yourcompany.com"},"department":{"type":"string","title":"Department","description":"The department of the business card.","example":"IT"},"email":{"type":"string","title":"Email","description":"The email of the business card.","example":"john.doe@yourcompany.com"},"email_private":{"type":"string","title":"Email Private","description":"The private email of the business card.","example":"john.doe.private@yourcompany.com"},"street":{"type":"string","title":"Street","description":"The street of the business card.","example":"Times Square 1"},"zip":{"type":"string","title":"Zip","description":"The ZIP code of the business card.","example":"10036"},"city":{"type":"string","title":"City","description":"The city of the business card.","example":"New York"},"country_code":{"type":"string","title":"Country Code","description":"The country code of the business card.","example":"USA"},"state":{"type":"string","title":"State","description":"The state of the business card.","example":"NY"},"user_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Image Url","description":"The url to get the user image of the digital business card.","example":"https://qr.yourdomain.com/resources/xxx/lp/yyy/zzz-user.jpg"},"logo_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Logo Image Url","description":"The url to get the logo image of the digital business card.","example":"https://qr.yourdomain.com/resources/xxx/lp/yyy/zzz-logo.jpg"},"background_image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Background Image Url","description":"The url to get the background image of the digital business card.","example":"https://qr.yourdomain.com/resources/xxx/lp/yyy/zzz-background.jpg"},"vcard_download_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Vcard Download Url","description":"The download url to download the .vcf file of the digital business card.","example":"https://qr.yourdomain.com/vcard/doe-john"}},"type":"object","title":"BusinessCardGetResponse"},"BusinessCardListResponse":{"properties":{"code":{"type":"string","title":"Code","description":"The code of the QR code (either provided vanity code or randomly generated code if not provided).","example":"doe-john"},"title":{"type":"string","title":"Title","description":"Title of the Business Card QR code - this is usually 'firstname lastname'.","example":"John Doe"}},"type":"object","title":"BusinessCardListResponse"},"BusinessCardMode":{"type":"string","enum":["BCARD"],"title":"BusinessCardMode"},"BusinessCardPatchRequest":{"properties":{"folder_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id","description":"The id of the folder you want the business card to be in (optional).\n- For a Business Card (BCARD) the folder needs to have the type `LANDING_PAGE`\n- For a VCARD the folder needs to have the type `QR_CODE`.","example":"BCARD"},"template_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Template Code","description":"The code of the Digital Business Card you want to use as a template for the created/updated Digital Business Card (optional).","example":"abc123"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"The first name of the business card.","example":"John"},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"The first name of the business card.","example":"Doe"},"job":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job","description":"The job of the business card (bcard job).","example":"Software Engineer"},"role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role","description":"The role of the business card (bcard role).","example":"Backend Developer"},"company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company","description":"The company name of the business card.","example":"Your Company Inc"},"company_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Url","description":"The URL of the website of the business card.","example":"https://yourcompany.com"},"department":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Department","description":"The department of the business card.","example":"IT"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"The email of the business card.","example":"john.doe@yourcompany.com"},"email_private":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email Private","description":"The private email of the business card.","example":"john.doe.private@yourcompany.com"},"street":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Street","description":"The street of the business card.","example":"Times Square 1"},"zip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zip","description":"The ZIP code of the business card.","example":"10036"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"The city of the business card.","example":"New York"},"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country Code","description":"The country code of the business card.","example":"USA"},"state":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"State","description":"The state of the business card.","example":"NY"}},"type":"object","title":"BusinessCardPatchRequest"},"CountryAddRequest":{"properties":{"country_code":{"type":"string","title":"Country Code","description":"2-letter country code","example":"IT"},"target_url":{"type":"string","title":"Target Url","description":"The target url the dynamic QR code redirects to.","example":"https://test.de"}},"type":"object","title":"CountryAddRequest"},"CountryAddResponse":{"properties":{"code":{"type":"string","title":"Code","description":"The code of the QR code (either provided vanity code or randomly generated code if not provided).","example":"easter-promotion-2"},"country_code":{"type":"string","title":"Country Code","description":"2-letter country code","example":"IT"},"target_url":{"type":"string","title":"Target Url","description":"The target url the dynamic QR code redirects to.","example":"https://test.de"}},"type":"object","title":"CountryAddResponse"},"CouponGetResponse":{"properties":{"code":{"type":"string","title":"Code","description":"The code of the QR code (either provided vanity code or randomly generated code if not provided).","example":"easter-promotion-coupon"},"short_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Short Url","description":"This is the URL where your Coupon QR Code is reachable. You can use this URL as an alternative of scanning the QR code - eg. if you want to use it in a social media post.","example":"https://qr.yourdomain.com/easter-promotion-coupon"},"title":{"type":"string","title":"Title","description":"The title of the coupon that is shown when displaying the QR code in the QR code portal.","example":"My Coupon Code"}},"type":"object","title":"CouponGetResponse"},"DateRelativeRange":{"type":"string","enum":["today","yesterday","last7","last14","last28","last30","last31","last365"],"title":"DateRelativeRange"},"DecimalSeparator":{"type":"string","enum":[".",","],"title":"DecimalSeparator"},"DesignerTemplateDetailResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of a designer template.","example":"42f88fb1de80ca479f87942c23ea74be"},"name":{"type":"string","title":"Name","description":"Name of a designer template.","example":"Spotify"},"type":{"$ref":"#/components/schemas/DesignerTemplateType","description":"Type of a designer template.","example":"USER"},"label":{"type":"string","title":"Label","description":"Label of a designer template.","example":"Spotify"},"allow_to_render":{"type":"boolean","title":"Allow To Render","description":"Flag if the designer template is allowed to be rendered.","example":true},"sample_url":{"type":"string","title":"Sample Url","description":"URL of a sample image of this designer template. Can be used to get a feeling of how QR code that is generated with this designer template will look like.","example":false}},"type":"object","title":"DesignerTemplateDetailResponse"},"DesignerTemplateListDetailResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of a designer template.","example":"42f88fb1de80ca479f87942c23ea74be"},"name":{"type":"string","title":"Name","description":"Name of a designer template.","example":"Spotify"},"type":{"$ref":"#/components/schemas/DesignerTemplateType","description":"Type of a designer template.","example":"USER"},"label":{"type":"string","title":"Label","description":"Label of a designer template.","example":"Spotify"},"allow_to_render":{"type":"boolean","title":"Allow To Render","description":"Flag if the designer template is allowed to be rendered.","example":true},"sample_url":{"type":"string","title":"Sample Url","description":"URL of a sample image of this designer template. Can be used to get a feeling of how QR code that is generated with this designer template will look like.","example":false}},"type":"object","title":"DesignerTemplateListDetailResponse"},"DesignerTemplateType":{"type":"string","enum":["USER","PREDEFINED"],"title":"DesignerTemplateType"},"ErrorCorrectionLevel":{"type":"string","enum":["L","M","Q","H"],"title":"ErrorCorrectionLevel"},"FolderCreateRequest":{"properties":{"name":{"type":"string","title":"Name","description":"Name of a folder.","example":"XMAS Promotion"},"type":{"$ref":"#/components/schemas/FolderType","description":"Type of a folder.","example":"QR_CODE"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Id","description":"Unique identifier of the parent folder.","example":"12345"}},"type":"object","title":"FolderCreateRequest"},"FolderCreateResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of a folder.","example":"12345"},"name":{"type":"string","title":"Name","description":"Name of a folder.","example":"XMAS Promotion"},"type":{"$ref":"#/components/schemas/FolderType","description":"Type of a folder.","example":"QR_CODE"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Id","description":"Unique identifier of the parent folder.","example":"12345"}},"type":"object","title":"FolderCreateResponse"},"FolderDetailResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of a folder.","example":"12345"},"name":{"type":"string","title":"Name","description":"Name of a folder.","example":"XMAS Promotion"},"type":{"$ref":"#/components/schemas/FolderType","description":"Type of a folder.","example":"QR_CODE"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Id","description":"Unique identifier of the parent folder.","example":"12345"},"has_subfolders":{"type":"boolean","title":"Has Subfolders","description":"Flag if the folder has subfolders","example":true},"is_archived":{"type":"boolean","title":"Is Archived","description":"Flag if the folder is archived.","example":false}},"type":"object","title":"FolderDetailResponse"},"FolderListDetailResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of a folder.","example":"12345"},"name":{"type":"string","title":"Name","description":"Name of a folder.","example":"XMAS Promotion"},"type":{"$ref":"#/components/schemas/FolderType","description":"Type of a folder.","example":"QR_CODE"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Id","description":"Unique identifier of the parent folder.","example":"12345"},"has_subfolders":{"type":"boolean","title":"Has Subfolders","description":"Flag if the folder has subfolders","example":true},"is_archived":{"type":"boolean","title":"Is Archived","description":"Flag if the folder is archived.","example":false}},"type":"object","title":"FolderListDetailResponse"},"FolderType":{"type":"string","enum":["QR_CODE","LANDING_PAGE"],"title":"FolderType"},"GS1CreateRequest":{"properties":{"primary_key_ai":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Primary Key Ai","description":"The primary key *application identifier (AI)* you want to use. This is basically the type of primary key you want to use. Its usually the type `GTIN` which is expressed via `01`.\n\n- [Full list of Application Identifiers (AI)](https://ref.gs1.org/ai/).\n- You can basically use all Application Identifiers that are marked with *Primary key in a GS1 Digital Link URI*: `Yes`. You find this information when you click on a specific AI in the list and jump into the detail view.","default":"01","example":"01"},"primary_key_value":{"type":"string","title":"Primary Key Value","description":"The primary key *value* you want to use (as specified in the `primary_key_ai`). Its usually the concrete `GTIN`.","example":"5449000297280"},"default_target_url":{"type":"string","title":"Default Target Url","description":"The default target url the GS1 Digital Link QR code redirects to. This is the default url that is going to be used if there is no match of a specific language/linktype Rule (see the Rules endpoint).","example":"https://www.coca-cola.com/ca/en/brands/coca-cola/products/coca-cola-original-taste"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"A title that is shown in the list of QR Codes, so you can spot quickly what this GS1 Digital Link is about. You can enter the name of the product here as an example.","example":"Coca-Cola Original Taste 500 ml Bottle"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"A description for the GS1 Digital Link. This is just an additional information to be stored.","example":"Soda. Pop. Soft drink. Sparkling beverage. Carbonated drink. Whatever you call it, nothing compares to the refreshing, crisp taste of Coca‑Cola, the delicious soda you know and love."},"cpv_variant":{"anyOf":[{"type":"string","maxLength":20,"minLength":1},{"type":"null"}],"title":"Cpv Variant","description":"Consumer Product Variant (AI 22). Example: color/size/variant.","example":"blue"},"batch_number":{"anyOf":[{"type":"string","maxLength":20,"minLength":1},{"type":"null"}],"title":"Batch Number","description":"Lot/batch number (AI 10).","example":"batch-2026-37"},"serial_number":{"anyOf":[{"type":"string","maxLength":20,"minLength":1},{"type":"null"}],"title":"Serial Number","description":"Serial number (AI 21).","example":"sn/999abc"},"folder_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id","description":"Folder you want the GS1 Digital Link QR Code to be created in.","example":"12345"},"data_attributes":{"anyOf":[{"items":{"$ref":"#/components/schemas/GS1DataAttribute"},"type":"array"},{"type":"null"}],"title":"Data Attributes","description":"Additional GS1 Application Identifiers (AI) placed in the query part of the Digital Link (e.g. expiry date AI 17).\n\nTypical Data Attributes:\n\nData Attribute (AI)|Additional Information\n---|---\n11|Production date (YYMMDD)\n17|Expiry Date (YYMMDD)\n\n[Full list of Application Identifiers (AI)](https://ref.gs1.org/ai/)","example":[{"ai":"17","value":"291231"}]}},"type":"object","title":"GS1CreateRequest"},"GS1CreateResponse":{"properties":{"code":{"type":"string","title":"Code","description":"Code that identifies a QR code of a GS1 Digital Link. Its got automatically assigned during creation. *- example: 913e39f179f883d36c2eb6f99ac20b99*","example":"913e39f179f883d36c2eb6f99ac20b99"},"short_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Short Url","description":"This is the URL where your QR Code is reachable. You can use this URL as an alternative of scanning the QR code - eg. if you want to use it in a social media post.","example":"https://qr.yourdomain.com/913e39f179f883d36c2eb6f99ac20b99"},"default_target_url":{"type":"string","title":"Default Target Url","description":"The default target url the GS1 Digital Link QR code redirects to. This is the default url that is going to be used if there is no match of a specific language/linktype Rule (see the Rules endpoint).","example":"https://www.coca-cola.com/ca/en/brands/coca-cola/products/coca-cola-original-taste"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"A title that is shown in the list of QR Codes, so you can spot quickly what this GS1 Digital Link is about. You can enter the name of the product here as an example.","example":"Coca-Cola Original Taste 500 ml Bottle"},"creation_at":{"type":"string","format":"date-time","title":"Creation At","description":"The creation date and time for the GS1 Digital Link QR Code.","example":"2025-09-01T11:11:11"}},"type":"object","title":"GS1CreateResponse"},"GS1CreateRuleRequest":{"properties":{"languages":{"items":{"type":"string"},"type":"array","title":"Languages","description":"Languages where this Rule should be applied to. Languages are encoded in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format with 2 characters (e.g. en, de, es, etc.).\n\nIf you don't specify a language then this rule is going to be used if no specific language rule for this LinkType is found (catchall). ","example":["en","de"]},"linktypes":{"items":{"type":"string"},"type":"array","title":"Linktypes","description":"LinkType where this RUle should be applied to. The following LinkTypes are possible:\n\n\n| LinkType | Name |\n|--------|------|\n| gs1:activityIdeas | Activity Ideas |\n| gs1:allergenInfo | Allergen Information |\n| gs1:appDownload | App Download |\n| gs1:brandHomepageClinical | Brand Homepage Clinical |\n| gs1:brandHomepagePatient | Brand Homepage Patient |\n| gs1:careersInfo | Careers Information |\n| gs1:certificationInfo | Certification Information |\n| gs1:consumerHandlingStorageInfo | Consumer Handling and Storage Information |\n| gs1:defaultLink | Default Link |\n| gs1:defaultLinkMulti | Default Link Multi |\n| gs1:epcis | EPCIS |\n| gs1:epil | Electronic Patient Information Leaflet |\n| gs1:eventsInfo | Events Information |\n| gs1:faqs | FAQs |\n| gs1:handledBy | Handled By |\n| gs1:hasRetailers | Has Retailers |\n| gs1:homepage | Homepage |\n| gs1:ingredientsInfo | Ingredients Information |\n| gs1:instructions | Instructions |\n| gs1:jws | JSON Web Signature |\n| gs1:leaveReview | Leave a Review |\n| gs1:locationInfo | Location Information |\n| gs1:logisticsInfo | Logistics Information |\n| gs1:loyaltyProgram | Loyalty Program |\n| gs1:masterData | Master Data |\n| gs1:menuInfo | Menu Information |\n| gs1:nutritionalInfo | Nutritional Information |\n| gs1:openingHoursInfo | Opening Hours Information |\n| gs1:paymentLink | Payment Link |\n| gs1:pip | Product Information Page |\n| gs1:promotion | Promotion |\n| gs1:purchaseSuppliesOrAccessories | Purchase Supplies or Accessories |\n| gs1:quickStartGuide | Quick Start Guide |\n| gs1:recallStatus | Recall Status |\n| gs1:recipeInfo | Recipe Information |\n| gs1:registerProduct | Register Product |\n| gs1:registryEntry | Registry Entry |\n| gs1:relatedImage | Related Image |\n| gs1:relatedVideo | Related Video |\n| gs1:review | Review |\n| gs1:safetyInfo | Safety Information |\n| gs1:scheduleTime | Schedule Time |\n| gs1:serviceInfo | Service Information |\n| gs1:smartLabel | SmartLabel |\n| gs1:smpc | Summary Product Characteristics |\n| gs1:socialMedia | Social Media |\n| gs1:statisticInfo | Statistic Information |\n| gs1:subscribe | Subscribe |\n| gs1:support | Support |\n| gs1:sustainabilityInfo | Sustainability Information |\n| gs1:traceability | Traceability |\n| gs1:tutorial | Tutorial |\n| gs1:userAgreement | User Agreement |\n| gs1:verificationService | Verification Service |\n| gs1:whatsInTheBox | What's In The Box |\n","example":["gs1:pip","gs1:relatedVideo"]},"target_url":{"type":"string","title":"Target Url","description":"This is the URL that a user is going to be redirected to if the Rule matches. Eg. for a product information in german.","example":"https://www.coca-cola.com/de/de/brands/brand-coca-cola"}},"type":"object","title":"GS1CreateRuleRequest"},"GS1CreateRuleResponse":{"properties":{"code":{"type":"string","title":"Code","description":"Code that identifies a QR code of a GS1 Digital Link. Its got automatically assigned during creation. *- example: 913e39f179f883d36c2eb6f99ac20b99*","example":"913e39f179f883d36c2eb6f99ac20b99"},"languages":{"items":{"type":"string"},"type":"array","title":"Languages","description":"Languages where this Rule should be applied to. Languages are encoded in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format with 2 characters (e.g. en, de, es, etc.).\n\nIf you don't specify a language then this rule is going to be used if no specific language rule for this LinkType is found (catchall). ","example":["en","de"]},"linktypes":{"items":{"type":"string"},"type":"array","title":"Linktypes","description":"LinkType where this RUle should be applied to. The following LinkTypes are possible:\n\n\n| LinkType | Name |\n|--------|------|\n| gs1:activityIdeas | Activity Ideas |\n| gs1:allergenInfo | Allergen Information |\n| gs1:appDownload | App Download |\n| gs1:brandHomepageClinical | Brand Homepage Clinical |\n| gs1:brandHomepagePatient | Brand Homepage Patient |\n| gs1:careersInfo | Careers Information |\n| gs1:certificationInfo | Certification Information |\n| gs1:consumerHandlingStorageInfo | Consumer Handling and Storage Information |\n| gs1:defaultLink | Default Link |\n| gs1:defaultLinkMulti | Default Link Multi |\n| gs1:epcis | EPCIS |\n| gs1:epil | Electronic Patient Information Leaflet |\n| gs1:eventsInfo | Events Information |\n| gs1:faqs | FAQs |\n| gs1:handledBy | Handled By |\n| gs1:hasRetailers | Has Retailers |\n| gs1:homepage | Homepage |\n| gs1:ingredientsInfo | Ingredients Information |\n| gs1:instructions | Instructions |\n| gs1:jws | JSON Web Signature |\n| gs1:leaveReview | Leave a Review |\n| gs1:locationInfo | Location Information |\n| gs1:logisticsInfo | Logistics Information |\n| gs1:loyaltyProgram | Loyalty Program |\n| gs1:masterData | Master Data |\n| gs1:menuInfo | Menu Information |\n| gs1:nutritionalInfo | Nutritional Information |\n| gs1:openingHoursInfo | Opening Hours Information |\n| gs1:paymentLink | Payment Link |\n| gs1:pip | Product Information Page |\n| gs1:promotion | Promotion |\n| gs1:purchaseSuppliesOrAccessories | Purchase Supplies or Accessories |\n| gs1:quickStartGuide | Quick Start Guide |\n| gs1:recallStatus | Recall Status |\n| gs1:recipeInfo | Recipe Information |\n| gs1:registerProduct | Register Product |\n| gs1:registryEntry | Registry Entry |\n| gs1:relatedImage | Related Image |\n| gs1:relatedVideo | Related Video |\n| gs1:review | Review |\n| gs1:safetyInfo | Safety Information |\n| gs1:scheduleTime | Schedule Time |\n| gs1:serviceInfo | Service Information |\n| gs1:smartLabel | SmartLabel |\n| gs1:smpc | Summary Product Characteristics |\n| gs1:socialMedia | Social Media |\n| gs1:statisticInfo | Statistic Information |\n| gs1:subscribe | Subscribe |\n| gs1:support | Support |\n| gs1:sustainabilityInfo | Sustainability Information |\n| gs1:traceability | Traceability |\n| gs1:tutorial | Tutorial |\n| gs1:userAgreement | User Agreement |\n| gs1:verificationService | Verification Service |\n| gs1:whatsInTheBox | What's In The Box |\n","example":["gs1:pip","gs1:relatedVideo"]}},"type":"object","title":"GS1CreateRuleResponse"},"GS1DataAttribute":{"properties":{"ai":{"type":"string","title":"Ai","description":"GS1 Application Identifier (AI) to be put into the query part (e.g. '17' for expiry date).\n\n- [Full list of Application Identifiers (AI)](/help/en/article/what-is-an-application-identifier-ai-according-to-gs1).","example":"17"},"value":{"type":"string","title":"Value","description":"Value for that AI (format depends on AI).","example":"20291231"}},"type":"object","required":["ai","value"],"title":"GS1DataAttribute"},"GS1GetRuleResponse":{"properties":{"code":{"type":"string","title":"Code","description":"Code that identifies a QR code of a GS1 Digital Link. Its got automatically assigned during creation. *- example: 913e39f179f883d36c2eb6f99ac20b99*","example":"913e39f179f883d36c2eb6f99ac20b99"},"id":{"type":"string","title":"Id","description":"This is the ID of the GS1 Digital Link Rule.","example":"4711"},"languages":{"items":{"type":"string"},"type":"array","title":"Languages","description":"Languages where this Rule should be applied to. Languages are encoded in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format with 2 characters (e.g. en, de, es, etc.).\n\nIf you don't specify a language then this rule is going to be used if no specific language rule for this LinkType is found (catchall). ","example":["en","de"]},"linktypes":{"items":{"type":"string"},"type":"array","title":"Linktypes","description":"LinkType where this RUle should be applied to. The following LinkTypes are possible:\n\n\n| LinkType | Name |\n|--------|------|\n| gs1:activityIdeas | Activity Ideas |\n| gs1:allergenInfo | Allergen Information |\n| gs1:appDownload | App Download |\n| gs1:brandHomepageClinical | Brand Homepage Clinical |\n| gs1:brandHomepagePatient | Brand Homepage Patient |\n| gs1:careersInfo | Careers Information |\n| gs1:certificationInfo | Certification Information |\n| gs1:consumerHandlingStorageInfo | Consumer Handling and Storage Information |\n| gs1:defaultLink | Default Link |\n| gs1:defaultLinkMulti | Default Link Multi |\n| gs1:epcis | EPCIS |\n| gs1:epil | Electronic Patient Information Leaflet |\n| gs1:eventsInfo | Events Information |\n| gs1:faqs | FAQs |\n| gs1:handledBy | Handled By |\n| gs1:hasRetailers | Has Retailers |\n| gs1:homepage | Homepage |\n| gs1:ingredientsInfo | Ingredients Information |\n| gs1:instructions | Instructions |\n| gs1:jws | JSON Web Signature |\n| gs1:leaveReview | Leave a Review |\n| gs1:locationInfo | Location Information |\n| gs1:logisticsInfo | Logistics Information |\n| gs1:loyaltyProgram | Loyalty Program |\n| gs1:masterData | Master Data |\n| gs1:menuInfo | Menu Information |\n| gs1:nutritionalInfo | Nutritional Information |\n| gs1:openingHoursInfo | Opening Hours Information |\n| gs1:paymentLink | Payment Link |\n| gs1:pip | Product Information Page |\n| gs1:promotion | Promotion |\n| gs1:purchaseSuppliesOrAccessories | Purchase Supplies or Accessories |\n| gs1:quickStartGuide | Quick Start Guide |\n| gs1:recallStatus | Recall Status |\n| gs1:recipeInfo | Recipe Information |\n| gs1:registerProduct | Register Product |\n| gs1:registryEntry | Registry Entry |\n| gs1:relatedImage | Related Image |\n| gs1:relatedVideo | Related Video |\n| gs1:review | Review |\n| gs1:safetyInfo | Safety Information |\n| gs1:scheduleTime | Schedule Time |\n| gs1:serviceInfo | Service Information |\n| gs1:smartLabel | SmartLabel |\n| gs1:smpc | Summary Product Characteristics |\n| gs1:socialMedia | Social Media |\n| gs1:statisticInfo | Statistic Information |\n| gs1:subscribe | Subscribe |\n| gs1:support | Support |\n| gs1:sustainabilityInfo | Sustainability Information |\n| gs1:traceability | Traceability |\n| gs1:tutorial | Tutorial |\n| gs1:userAgreement | User Agreement |\n| gs1:verificationService | Verification Service |\n| gs1:whatsInTheBox | What's In The Box |\n","example":["gs1:pip","gs1:relatedVideo"]},"target_url":{"type":"string","title":"Target Url","description":"This is the URL that a user is going to be redirected to if the Rule matches. Eg. for a product information in german.","example":"https://www.coca-cola.com/de/de/brands/brand-coca-cola"}},"type":"object","title":"GS1GetRuleResponse"},"GeoFenceAddRequest":{"properties":{"lat":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lat","description":"Latitude coordinate"},"lng":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lng","description":"Longitude coordinate"},"radius":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Radius","description":"the maximal allowed radius (in m) around the lng/lat position the user is allowed to be. Assume a radius of at least 100m to account for any measurement inaccuracies."},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address","description":"Address for the geo-fenced target. This is optional additional information you can provide. From a technical standpoint only the `lat` and `lng` are being used."},"target_url":{"type":"string","title":"Target Url","description":"The target url the dynamic QR code redirects to.","example":"https://test.de"},"description":{"type":"string","title":"Description","description":"Description you want to add."}},"type":"object","title":"GeoFenceAddRequest"},"GeoFenceAddResponse":{"properties":{"code":{"type":"string","title":"Code","description":"The code of the QR code (either provided vanity code or randomly generated code if not provided).","example":"easter-promotion-2"},"id":{"type":"string","title":"Id","description":"ID of the Geofence-specific rule.","example":"4711"},"lat":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lat","description":"Latitude coordinate"},"lng":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lng","description":"Longitude coordinate"},"radius":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Radius","description":"the maximal allowed radius (in m) around the lng/lat position the user is allowed to be. Assume a radius of at least 100m to account for any measurement inaccuracies."},"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address","description":"Address for the geo-fenced target. This is optional additional information you can provide. From a technical standpoint only the `lat` and `lng` are being used."},"target_url":{"type":"string","title":"Target Url","description":"The target url the dynamic QR code redirects to.","example":"https://test.de"},"description":{"type":"string","title":"Description","description":"Description you want to add."}},"type":"object","title":"GeoFenceAddResponse"},"GeoFencing":{"properties":{"countries":{"items":{"$ref":"#/components/schemas/CountryAddResponse"},"type":"array","title":"Countries","description":"List of country-specific geofences"},"languages":{"items":{"$ref":"#/components/schemas/LanguageAddResponse"},"type":"array","title":"Languages","description":"List of language-speficic geofences."},"geofences":{"items":{"$ref":"#/components/schemas/GeoFenceAddResponse"},"type":"array","title":"Geofences","description":"List of coordinate/address based geofences."},"georegions":{"items":{"$ref":"#/components/schemas/GeoRegionAddResponse"},"type":"array","title":"Georegions","description":"List of region-specific geofences."}},"type":"object","title":"GeoFencing"},"GeoRegionAddRequest":{"properties":{"region":{"type":"string","title":"Region","description":"Region that triggers a redirect to a specific target URL."},"target_url":{"type":"string","title":"Target Url","description":"The target url the dynamic QR code redirects to.","example":"https://test.de"}},"type":"object","title":"GeoRegionAddRequest"},"GeoRegionAddResponse":{"properties":{"code":{"type":"string","title":"Code","description":"The code of the QR code (either provided vanity code or randomly generated code if not provided).","example":"easter-promotion-2"},"id":{"type":"string","title":"Id","description":"ID of the Region-specific rule.","example":"4711"},"region":{"type":"string","title":"Region","description":"Region that triggers a redirect to a specific target URL."},"target_url":{"type":"string","title":"Target Url","description":"The target url the dynamic QR code redirects to.","example":"https://test.de"}},"type":"object","title":"GeoRegionAddResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HealthResponse":{"properties":{"status":{"type":"string","title":"Status","default":"ok"}},"type":"object","title":"HealthResponse"},"ImageFormatBasic":{"type":"string","enum":["PNG","EPS","PDF","SVG"],"title":"ImageFormatBasic"},"ImageFormatDesigner":{"type":"string","enum":["PNG","PDF","PDF-CMYK","EPS","SVG"],"title":"ImageFormatDesigner"},"ImageKind":{"type":"string","enum":["USER","LOGO","BACKGROUND"],"title":"ImageKind"},"IssueRedemptionsResponse":{"properties":{"code":{"type":"string","title":"Code","description":"The code of the QR code (either provided vanity code or randomly generated code if not provided).","example":"easter-promotion-coupon"},"voucher_code":{"type":"string","title":"Voucher Code","description":"The code of the Voucher.","example":"l6xqesi5b2g8yahfwzov7pt304jcmd91"},"issue_type":{"$ref":"#/components/schemas/IssueType","description":"Type of how the coupon got issued (In the old v1 API this was called redeemtype).","example":"LEAD"},"redeemed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Redeemed At","description":"The redemption date and time of the voucher.","example":"2025-09-01T11:11:11"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email","description":"The email address of a voucher redemption.","example":"someone@somecompany.com"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The name of a voucher redemption.","example":"John Doe"},"brand":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Brand","description":"The brand of the device of a voucher redemption.","example":"Apple"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"The device model of a voucher redemption.","example":"iPhone"},"browser":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Browser","description":"The browser of a voucher redemption.","example":"Mobile Safari"},"os":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Os","description":"The operating system (OS) of a voucher redemption.","example":"iOS"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"The country name of a voucher redemption.","example":"Greece"},"lat":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lat","description":"The latitude (lat) of a voucher redemption.","example":48.2675},"lng":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lng","description":"The longtitude (lng) of a voucher redemption.","example":16.3909},"accuracy":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Accuracy","description":"The accuracy of a voucher redemption.","example":4.122},"localization_successful":{"type":"boolean","title":"Localization Successful","description":"Flag indicating if the localization was successful of a voucher redemption.","example":true}},"type":"object","title":"IssueRedemptionsResponse"},"IssueStatisticsResponse":{"properties":{"code":{"type":"string","title":"Code","description":"The code of the QR code (either provided vanity code or randomly generated code if not provided).","example":"easter-promotion-coupon"},"short_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Short Url","description":"This is the URL where your Coupon QR Code is reachable. You can use this URL as an alternative of scanning the QR code - eg. if you want to use it in a social media post.","example":"https://qr.yourdomain.com/easter-promotion-coupon"},"title":{"type":"string","title":"Title","description":"The title of the coupon that is shown when displaying the QR code in the QR code portal.","example":"My Coupon Code"},"total_vouchers":{"type":"integer","title":"Total Vouchers","description":"Total number of vouchers (in the group) of a coupon.","example":1000},"issued_vouchers":{"type":"integer","title":"Issued Vouchers","description":"Number of issued vouchers (in the group) of a coupon.","example":150},"available_vouchers":{"type":"integer","title":"Available Vouchers","description":"Number of available vouchers (in the group) of a coupon.","example":850},"redeemed_vouchers":{"type":"integer","title":"Redeemed Vouchers","description":"Number of redeemed vouchers (in the group) of a coupon.","example":15},"first_redemption_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"First Redemption At","description":"Time of redemtpion of the first voucher (in the group) of a coupon.","example":"2025-09-01T11:11:11"},"last_redemption_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Redemption At","description":"Time of redemption of the last voucher (in the group) of a coupon.","example":"2025-09-15T15:15:15"}},"type":"object","title":"IssueStatisticsResponse"},"IssueType":{"type":"string","enum":["LEAD","MAILCHIMP","NEWSLETTER","API","BULK"],"title":"IssueType"},"IssueVoucherRequest":{"properties":{"group":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group","description":"The issue group that is being used for the issuing of this voucher.","example":"group4711"},"ttl":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Ttl","description":"If the optional ttl (time to live) parameter is set, the issue date of the voucher will expire after ttl days, when the voucher has not been redeemed. When the voucher has expired, he will be deleted. ","example":14}},"type":"object","title":"IssueVoucherRequest"},"IssueVoucherResponse":{"properties":{"code":{"type":"string","title":"Code","description":"The code of the QR code (either provided vanity code or randomly generated code if not provided).","example":"easter-promotion-coupon"},"voucher_code":{"type":"string","title":"Voucher Code","description":"The code of the Voucher.","example":"l6xqesi5b2g8yahfwzov7pt304jcmd91"},"group":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group","description":"The issue group that is being used for the issuing of this voucher.","example":"group4711"},"issued_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Issued At","description":"The date and time of when the voucher has been issued.","example":"2025-09-01T11:11:11"},"expires_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Expires At","description":"The date and time of when the voucher will expire (based on the `ttl`). After the `expires_at` date, the voucher is deleted. `expires_at` is only shown when `ttl` parameter is set. ","example":"2025-09-15T15:15:15"},"coupon_valid_from":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Coupon Valid From","description":"The date and time the coupon will begin to be valid.","example":"2025-09-01T11:11:11"},"coupon_valid_to":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Coupon Valid To","description":"The date and time the coupon will end to be valid.","example":"2025-09-15T15:15:15"},"redemption_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Redemption Url","description":"The URL of the landing page where the uniuqe voucher can be redeemed.","example":"https://qr.yourdomain.com/easter-promotion-coupon"},"immediate_redemption_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Immediate Redemption Url","description":"The URL that will redeem the voucher immediately when scanned..","example":"https://qr.yourdomain.com/v/omuhjv3lg72spzf6x08d5ibarqe9w4nk"},"unique_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unique Id","description":"Unique ID of a user for the voucher.","example":"z7osy5en04maxptflqgruwd23jci1hbk"},"qr_code_redemption_image_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Qr Code Redemption Image Url","description":"URL will show the QR Code that displays the landing page of the unique voucher when scanned.","example":"https://qr.yourdomain.com/d/omuhjv3lg72spzf6x08d5ibarqe9w4nk"},"qr_code_immediate_redemption_image_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Qr Code Immediate Redemption Image Url","description":"URL will show the QR Code that will redeem the voucher immediately when scanned.","example":"https://qr.yourdomain.com/r/omuhjv3lg72spzf6x08d5ibarqe9w4nk"},"quota":{"type":"integer","title":"Quota","description":"The number of vouchers you can issue.","example":1000}},"type":"object","title":"IssueVoucherResponse"},"LanguageAddRequest":{"properties":{"language_code":{"type":"string","title":"Language Code","description":"2-letter language code","example":"IT"},"target_url":{"type":"string","title":"Target Url","description":"The target url the dynamic QR code redirects to.","example":"https://test.de"}},"type":"object","title":"LanguageAddRequest"},"LanguageAddResponse":{"properties":{"code":{"type":"string","title":"Code","description":"The code of the QR code (either provided vanity code or randomly generated code if not provided).","example":"easter-promotion-2"},"language_code":{"type":"string","title":"Language Code","description":"2-letter language code","example":"IT"},"target_url":{"type":"string","title":"Target Url","description":"The target url the dynamic QR code redirects to.","example":"https://test.de"}},"type":"object","title":"LanguageAddResponse"},"LeadExportFormat":{"type":"string","enum":["JSON","CSV","XLSX"],"title":"LeadExportFormat"},"LeadItem":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Date and time when the entry of the lead was made (in local time).","example":"2025-09-01T11:11:11"},"code":{"type":"string","title":"Code","description":"The code of the QR code (either provided vanity code or randomly generated code if not provided).","example":"easter-promotion-2"},"referrer":{"type":"string","title":"Referrer","description":"Referer link of the page that redirected to the lead form.","example":"https://yourdomain.com/somepage"},"name":{"type":"string","title":"Name","description":"Name of the lead.","example":"Adam"},"email":{"type":"string","title":"Email","description":"Email address of the lead.","example":"adam@domain.com"},"located":{"type":"boolean","title":"Located","description":"Indication if the lead got located via GPS (gave consent to it).","example":true},"lat":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lat","description":"location latitude value of the lead when the lead entry was made.","example":40.758},"lng":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lng","description":"location longitude value of the lead when the lead entry was made.","example":-73.9855},"accuracy":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Accuracy","description":"location accuracy value of the lead when the lead entry was made.","example":100}},"type":"object","title":"LeadItem"},"Localized":{"type":"string","enum":["IP","SUCCESS","ERROR","NONAV","DENIED","TIMEOUT","TURNEDOFF",""],"title":"Localized"},"LocationData":{"properties":{"address":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Address","description":"Human-readable address"},"lat":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lat","description":"Latitude coordinate"},"lng":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lng","description":"Longitude coordinate"}},"type":"object","title":"LocationData"},"PageWithSummary_ScanStatSummary_ScanStatItem_":{"properties":{"summary":{"$ref":"#/components/schemas/app__api__v2__schemas__qrcodes__ScanStatSummary"},"items":{"items":{"$ref":"#/components/schemas/ScanStatItem"},"type":"array","title":"Items"},"page":{"type":"integer","title":"Page"},"size":{"type":"integer","title":"Size"},"total":{"type":"integer","title":"Total"},"pages":{"type":"integer","title":"Pages"}},"type":"object","required":["summary","items","page","size","total","pages"],"title":"PageWithSummary[ScanStatSummary, ScanStatItem]"},"Page_BusinessCardListResponse_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/BusinessCardListResponse"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[BusinessCardListResponse]"},"Page_CouponGetResponse_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/CouponGetResponse"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[CouponGetResponse]"},"Page_DesignerTemplateListDetailResponse_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/DesignerTemplateListDetailResponse"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[DesignerTemplateListDetailResponse]"},"Page_FolderListDetailResponse_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/FolderListDetailResponse"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[FolderListDetailResponse]"},"Page_GS1GetRuleResponse_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/GS1GetRuleResponse"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[GS1GetRuleResponse]"},"Page_IssueRedemptionsResponse_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/IssueRedemptionsResponse"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[IssueRedemptionsResponse]"},"Page_LeadItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/LeadItem"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[LeadItem]"},"Page_QRCodeOut_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/QRCodeOut"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[QRCodeOut]"},"QRCodeCreate":{"properties":{"static":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Static","description":"Indicates if it should be a static QR code instead of the default dynamic QR code. In case of a dynamic QR code the target url is provided in the field `target_url`. In case of static QR code the content is stored in field `content` and is directly encoded into the QR code.","default":false,"example":false},"target_url":{"type":"string","title":"Target Url","description":"The target url the dynamic QR code redirects to.","example":"https://test.de"},"content":{"type":"string","title":"Content","description":"The actual content of a static QR code like phone number or email address.","example":""},"slug":{"anyOf":[{"type":"string","maxLength":50,"minLength":3},{"type":"null"}],"title":"Slug","description":"An (optional) custom slug you want to use like easter-promotion-2 which leads to a final Short URL like https://qr.yourdomain.com/easter-promotion-2 (dependent on the domain you are using in your account). If not specified a random alphanumeric hash-value is being used for the Short URL like https://qr.yourdomain.com/ydr39. In the rest of the API you can access the QR code then via this slug in the `code` path parameter like GET /api/v2/qrcodes/{code}. This is also sometimes referred to as Vanity URL in the frontend UI.","example":"easter-promotion-2"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"The title of the target website that is shown when displaying the QR code in the QR code portal. If not specified the title of the target url is going to be used.","example":"Easter Promotion 2 2025"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"The description of the target website that is shown when displaying the QR code in the QR code portal. If not specified the meta description of the target url is going to be used. The description can also be a JSON string.","example":"Welcome to our Easter Promotion Relaunch 2025"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata","description":"Additional metadata as JSON object. The following reserved keys add the following parameters when forwarded:\n\nReserved key|Meaning\n---|---\n`{\"origin\":\"1\"}`|2-digit country code where QR code was scanned\n`{\"region\":\"1\"}`|Region where QR code was scanned\n`{\"lang\":\"1\"}`|Set language on the device from which the QR code was scanned\n`{\"tags\":\"1\"}`|Tags assigned to the QR code\n\nIf this metadata field is used, the `description` field cannot be used!\n","example":{"tracking_id":123,"your_custom_field":"value"}},"gps":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Gps","description":"Indicates if the GPS tracking is active.","default":false,"example":false},"notify_email":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Notify Email","description":"Indicates that the email notification is active when the QR Code is scanned","default":false,"example":false},"notify_sms":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Notify Sms","description":"Indicates that the sms notification is active when the QR Code is scanned","default":false,"example":false},"medium":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Medium","description":"A medium on which the QR Code will be printed can be specified. There are predefined medias like NEWSPAPER, PRODUCT, FLYER, POSTER, BUSINESS_CARD, PRODUCT_FOLDER, SHOPPING_WINDOW, WEBSITE, TV. However this field can contain any alpha-numeric string e.g. T-Shirt.","example":"FLYER"},"folder_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id","description":"Folder id where the QR code is stored.","example":"4711"},"password":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Password","description":" If you add the optional parameter password a user has to type in the correct password before he is being redirected to the target URL.","example":"mysecretpassword"},"location":{"anyOf":[{"$ref":"#/components/schemas/LocationData"},{"type":"null"}],"description":"Geodata can be transmitted with each QR code. This could be, for example, the company's website address or any location where the QR code is placed. The `address` parameter is a human-readable address. The `lat` (latitude) and `lng` (longitude) parameters are intended for automated processing, such as displaying the location on a map. The `image` parameter allows you to specify the path to a suitable image.","example":{"address":"Times Square, New York, NY 10036, USA","lat":40.758,"lng":-73.9855}}},"type":"object","title":"QRCodeCreate"},"QRCodeCreateOut":{"properties":{"code":{"type":"string","title":"Code","description":"The code of the QR code (either provided vanity code or randomly generated code if not provided).","example":"easter-promotion-2"},"short_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Short Url","description":"This is the URL where your QR Code is reachable. You can use this URL as an alternative of scanning the QR code - eg. if you want to use it in a social media post.","example":"https://qr.yourdomain.com/easter-promotion-2"},"qr_code_image_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Qr Code Image Url","description":"Url to the image of the QR code.","example":"https://qr.yourdomain.com/i/easter-promotion-2"},"static":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Static","description":"Indicates if it should be a static QR code instead of the default dynamic QR code. In case of a dynamic QR code the target url is provided in the field `target_url`. In case of static QR code the content is stored in field `content` and is directly encoded into the QR code.","default":false,"example":false},"target_url":{"type":"string","title":"Target Url","description":"The target url the dynamic QR code redirects to.","example":"https://test.de"},"content":{"type":"string","title":"Content","description":"The actual content of a static QR code like phone number or email address.","example":""},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"The title of the target website that is shown when displaying the QR code in the QR code portal. If not specified the title of the target url is going to be used.","example":"Easter Promotion 2 2025"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"The description of the target website that is shown when displaying the QR code in the QR code portal. If not specified the meta description of the target url is going to be used. The description can also be a JSON string.","example":"Welcome to our Easter Promotion Relaunch 2025"},"creation_at":{"type":"string","format":"date-time","title":"Creation At","description":"The creation date and time for the QR code.","example":"2025-09-01T11:11:11"},"gps":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Gps","description":"Indicates if the GPS tracking is active.","default":false,"example":false},"notify_email":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Notify Email","description":"Indicates that the email notification is active when the QR Code is scanned","default":false,"example":false},"notify_sms":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Notify Sms","description":"Indicates that the sms notification is active when the QR Code is scanned","default":false,"example":false},"medium":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Medium","description":"A medium on which the QR Code will be printed can be specified. There are predefined medias like NEWSPAPER, PRODUCT, FLYER, POSTER, BUSINESS_CARD, PRODUCT_FOLDER, SHOPPING_WINDOW, WEBSITE, TV. However this field can contain any alpha-numeric string e.g. T-Shirt.","example":"FLYER"},"folder_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Name","description":"Folder name where the QR code is stored.","example":"folder1"},"folder_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder Id","description":"Folder id where the QR code is stored.","example":"4711"}},"type":"object","title":"QRCodeCreateOut"},"QRCodeDetailOut":{"properties":{"code":{"type":"string","title":"Code","description":"The code of the QR code (either provided vanity code or randomly generated code if not provided).","example":"easter-promotion-2"},"short_url":{"type":"string","title":"Short Url","description":"This is the URL where your QR Code is reachable. You can use this URL as an alternative of scanning the QR code - eg. if you want to use it in a social media post.","example":"https://qr.yourdomain.com/easter-promotion-2"},"static":{"type":"boolean","title":"Static","description":"Indicates if it should be a static QR code instead of the default dynamic QR code. In case of a dynamic QR code the target url is provided in the field `target_url`. In case of static QR code the content is stored in field `content` and is directly encoded into the QR code.","default":false,"example":false},"target_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target Url","description":"The target url the dynamic QR code redirects to.","example":"https://test.de"},"content":{"type":"string","title":"Content","description":"The actual content of a static QR code like phone number or email address.","example":""},"type":{"type":"string","enum":["URL","BUSINESS_CARD","PRODUCT","OPENIMMO","COUPON","PLAIN","POSTER","SYNC","LEAD","SOCIAL","TRACING"],"title":"Type","description":"This is the QR Code type (default is URL). Allowed values: ['URL', 'BUSINESS_CARD', 'PRODUCT', 'OPENIMMO', 'COUPON', 'PLAIN', 'POSTER', 'SYNC', 'LEAD', 'SOCIAL', 'TRACING']","default":"URL"},"subtype":{"type":"string","enum":["URL","FACEBOOK_PAGE","FACEBOOK_LIKE","INSTAGRAM","SKYPE","APPSTORE","YOUTUBE","TWITTER","LINKEDIN","SMS","EMAIL","TEXT","VCARD","WLAN","GEO","PAYPAL","PINTEREST","GOOGLEPLUS","EVENT","PHONE","SEPA","MULTI","BITCOIN","VOUCHER","WHATSAPP","PDF","MULTI_LANGUAGE","MP3","MULTI_GEO","MULTI_GEO_CLOSEST","MULTI_REGION","UNLIMITED","UNIQUEIP","UNIQUEID","ONE","GS1"],"title":"Subtype","description":"This is the QR Code subtype. Allowed values: ['URL', 'FACEBOOK_PAGE', 'FACEBOOK_LIKE', 'INSTAGRAM', 'SKYPE', 'APPSTORE', 'YOUTUBE', 'TWITTER', 'LINKEDIN', 'SMS', 'EMAIL', 'TEXT', 'VCARD', 'WLAN', 'GEO', 'PAYPAL', 'PINTEREST', 'GOOGLEPLUS', 'EVENT', 'PHONE', 'SEPA', 'MULTI', 'BITCOIN', 'VOUCHER', 'WHATSAPP', 'PDF', 'MULTI_LANGUAGE', 'MP3', 'MULTI_GEO', 'MULTI_GEO_CLOSEST', 'MULTI_REGION', 'UNLIMITED', 'UNIQUEIP', 'UNIQUEID', 'ONE', 'GS1']","default":""},"folder_id":{"type":"string","title":"Folder Id","description":"Folder id where the QR code is stored.","example":"4711"},"folder_name":{"type":"string","title":"Folder Name","description":"Folder name where the QR code is stored.","example":"folder1"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"Tags of the QR code.","example":["tag1","tag2"]},"qr_code_image_url":{"type":"string","title":"Qr Code Image Url","default":"https://qr.yourdomain.com/i/easter-promotion-2"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"The title of the target website that is shown when displaying the QR code in the QR code portal. If not specified the title of the target url is going to be used.","example":"Easter Promotion 2 2025"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"The description of the target website that is shown when displaying the QR code in the QR code portal. If not specified the meta description of the target url is going to be used. The description can also be a JSON string.","example":"Welcome to our Easter Promotion Relaunch 2025"},"scan_count":{"type":"integer","title":"Scan Count","description":"The number of times the QR code has been scanned or clicked on the Short URL.","example":12},"unique_visitor_count":{"type":"integer","title":"Unique Visitor Count","description":"The number of unique visitors that scanned the QR Code or clicked on the Short URL.","example":10},"creation_at":{"type":"string","format":"date-time","title":"Creation At","description":"The creation date and time for the QR code.","example":"2025-09-01T11:11:11"},"gs1_slug":{"type":"string","title":"Gs1 Slug","description":"If the QR code is a GS1 QR code then the GS1 slug is shown here.","example":"01/00123456789012"},"location":{"anyOf":[{"$ref":"#/components/schemas/LocationData"},{"type":"null"}],"description":"Geodata can be transmitted with each QR code. This could be, for example, the company's website address or any location where the QR code is placed. The `address` parameter is a human-readable address. The `lat` (latitude) and `lng` (longitude) parameters are intended for automated processing, such as displaying the location on a map. The `image` parameter allows you to specify the path to a suitable image.","example":{"address":"Times Square, New York, NY 10036, USA","lat":40.758,"lng":-73.9855}},"geofencing":{"$ref":"#/components/schemas/GeoFencing","description":"Geofencing entries per country, language, region and position"},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata","description":"Additional metadata as JSON object. The following reserved keys add the following parameters when forwarded:\n\nReserved key|Meaning\n---|---\n`{\"origin\":\"1\"}`|2-digit country code where QR code was scanned\n`{\"region\":\"1\"}`|Region where QR code was scanned\n`{\"lang\":\"1\"}`|Set language on the device from which the QR code was scanned\n`{\"tags\":\"1\"}`|Tags assigned to the QR code\n\nIf this metadata field is used, the `description` field cannot be used!\n","example":{"tracking_id":123,"your_custom_field":"value"}},"medium":{"type":"string","title":"Medium","description":"A medium on which the QR Code will be printed can be specified. There are predefined medias like NEWSPAPER, PRODUCT, FLYER, POSTER, BUSINESS_CARD, PRODUCT_FOLDER, SHOPPING_WINDOW, WEBSITE, TV. However this field can contain any alpha-numeric string e.g. T-Shirt.","example":"FLYER"},"last_edit_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Edit At","description":"The creation date and time for the QR code.","example":"2025-09-15T15:15:15"},"first_scan_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"First Scan At","description":"The date and time of the first scan of the QR code.","example":"2025-09-01T11:11:11"},"last_scan_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Scan At","description":"The date and time of the last scan of the QR code.","example":"2025-09-15T15:15:15"}},"type":"object","title":"QRCodeDetailOut"},"QRCodeOut":{"properties":{"code":{"type":"string","title":"Code","description":"The code of the QR code (either provided vanity code or randomly generated code if not provided).","example":"easter-promotion-2"},"short_url":{"type":"string","title":"Short Url","description":"This is the URL where your QR Code is reachable. You can use this URL as an alternative of scanning the QR code - eg. if you want to use it in a social media post.","example":"https://qr.yourdomain.com/easter-promotion-2"},"static":{"type":"boolean","title":"Static","description":"Indicates if it should be a static QR code instead of the default dynamic QR code. In case of a dynamic QR code the target url is provided in the field `target_url`. In case of static QR code the content is stored in field `content` and is directly encoded into the QR code.","default":false,"example":false},"target_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target Url","description":"The target url the dynamic QR code redirects to.","example":"https://test.de"},"content":{"type":"string","title":"Content","description":"The actual content of a static QR code like phone number or email address.","example":""},"type":{"type":"string","enum":["URL","BUSINESS_CARD","PRODUCT","OPENIMMO","COUPON","PLAIN","POSTER","SYNC","LEAD","SOCIAL","TRACING"],"title":"Type","description":"This is the QR Code type (default is URL). Allowed values: ['URL', 'BUSINESS_CARD', 'PRODUCT', 'OPENIMMO', 'COUPON', 'PLAIN', 'POSTER', 'SYNC', 'LEAD', 'SOCIAL', 'TRACING']","default":"URL"},"subtype":{"type":"string","enum":["URL","FACEBOOK_PAGE","FACEBOOK_LIKE","INSTAGRAM","SKYPE","APPSTORE","YOUTUBE","TWITTER","LINKEDIN","SMS","EMAIL","TEXT","VCARD","WLAN","GEO","PAYPAL","PINTEREST","GOOGLEPLUS","EVENT","PHONE","SEPA","MULTI","BITCOIN","VOUCHER","WHATSAPP","PDF","MULTI_LANGUAGE","MP3","MULTI_GEO","MULTI_GEO_CLOSEST","MULTI_REGION","UNLIMITED","UNIQUEIP","UNIQUEID","ONE","GS1"],"title":"Subtype","description":"This is the QR Code subtype. Allowed values: ['URL', 'FACEBOOK_PAGE', 'FACEBOOK_LIKE', 'INSTAGRAM', 'SKYPE', 'APPSTORE', 'YOUTUBE', 'TWITTER', 'LINKEDIN', 'SMS', 'EMAIL', 'TEXT', 'VCARD', 'WLAN', 'GEO', 'PAYPAL', 'PINTEREST', 'GOOGLEPLUS', 'EVENT', 'PHONE', 'SEPA', 'MULTI', 'BITCOIN', 'VOUCHER', 'WHATSAPP', 'PDF', 'MULTI_LANGUAGE', 'MP3', 'MULTI_GEO', 'MULTI_GEO_CLOSEST', 'MULTI_REGION', 'UNLIMITED', 'UNIQUEIP', 'UNIQUEID', 'ONE', 'GS1']","default":""},"folder_id":{"type":"string","title":"Folder Id","description":"Folder id where the QR code is stored.","example":"4711"},"folder_name":{"type":"string","title":"Folder Name","description":"Folder name where the QR code is stored.","example":"folder1"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"Tags of the QR code.","example":["tag1","tag2"]},"qr_code_image_url":{"type":"string","title":"Qr Code Image Url","default":"https://qr.yourdomain.com/i/easter-promotion-2"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"The title of the target website that is shown when displaying the QR code in the QR code portal. If not specified the title of the target url is going to be used.","example":"Easter Promotion 2 2025"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"The description of the target website that is shown when displaying the QR code in the QR code portal. If not specified the meta description of the target url is going to be used. The description can also be a JSON string.","example":"Welcome to our Easter Promotion Relaunch 2025"},"scan_count":{"type":"integer","title":"Scan Count","description":"The number of times the QR code has been scanned or clicked on the Short URL.","example":12},"unique_visitor_count":{"type":"integer","title":"Unique Visitor Count","description":"The number of unique visitors that scanned the QR Code or clicked on the Short URL.","example":10},"creation_at":{"type":"string","format":"date-time","title":"Creation At","description":"The creation date and time for the QR code.","example":"2025-09-01T11:11:11"},"gs1_slug":{"type":"string","title":"Gs1 Slug","description":"If the QR code is a GS1 QR code then the GS1 slug is shown here.","example":"01/00123456789012"},"location":{"anyOf":[{"$ref":"#/components/schemas/LocationData"},{"type":"null"}],"description":"Geodata can be transmitted with each QR code. This could be, for example, the company's website address or any location where the QR code is placed. The `address` parameter is a human-readable address. The `lat` (latitude) and `lng` (longitude) parameters are intended for automated processing, such as displaying the location on a map. The `image` parameter allows you to specify the path to a suitable image.","example":{"address":"Times Square, New York, NY 10036, USA","lat":40.758,"lng":-73.9855}}},"type":"object","title":"QRCodeOut"},"QRCodePatch":{"properties":{"target_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Target Url","description":"The target url the dynamic QR code redirects to.","example":"https://test.de"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title","description":"The title of the target website that is shown when displaying the QR code in the QR code portal. If not specified the title of the target url is going to be used.","example":"Easter Promotion 2 2025"}},"type":"object","title":"QRCodePatch"},"QRCodeSubType":{"type":"string","enum":["URL","FACEBOOK_PAGE","FACEBOOK_LIKE","INSTAGRAM","SKYPE","APPSTORE","YOUTUBE","TWITTER","LINKEDIN","SMS","EMAIL","TEXT","VCARD","WLAN","GEO","PAYPAL","PINTEREST","GOOGLEPLUS","EVENT","PHONE","SEPA","MULTI","BITCOIN","VOUCHER","WHATSAPP","PDF","MULTI_LANGUAGE","MP3","MULTI_GEO","MULTI_GEO_CLOSEST","MULTI_REGION","UNLIMITED","UNIQUEIP","UNIQUEID","ONE","GS1"],"title":"QRCodeSubType"},"QRCodeType":{"type":"string","enum":["URL","BUSINESS_CARD","PRODUCT","OPENIMMO","COUPON","PLAIN","POSTER","SYNC","LEAD","SOCIAL","TRACING"],"title":"QRCodeType"},"ScanStatItem":{"properties":{"scan_id":{"type":"string","title":"Scan Id","description":"Unique id of the scan (so you know if you already processed this element or not).","example":"0bee89b07a248e27c83fc3d5951213c1"},"scan_at":{"type":"string","format":"date-time","title":"Scan At","description":"Date and time of the scan or click (in local time).","example":"2025-09-15T15:15:15"},"ip_anonymized":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ip Anonymized","description":"Anonymized IP of the scan","example":"5d01ffc86ca4287d8115df2a57b71a45"},"region":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Region","description":"Region where scanned","example":"Connecticut"},"country_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country Code","description":"2-letter country code","example":"IT"},"country":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Country","description":"Country name","example":"ITALY"},"localized":{"anyOf":[{"$ref":"#/components/schemas/Localized"},{"type":"null"}],"enum":["IP","SUCCESS","ERROR","NONAV","DENIED","TIMEOUT","TURNEDOFF",""],"description":"This is the localization type. Allowed values: ['IP', 'SUCCESS', 'ERROR', 'NONAV', 'DENIED', 'TIMEOUT', 'TURNEDOFF', '']"},"lat":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lat","description":"Latitude","example":"48.1992"},"lng":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Lng","description":"Longitude","example":"16.3566"},"accuracy":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Accuracy","description":"Accuracy of the coordinates in meters","example":"5000"},"street":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Street","description":"Street where the scan or click happened (if tracked)","example":"Deer Creek Rd"},"street_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Street Number","description":"Street number where the scan or click happened (if tracked)","example":"3500"},"postal_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Postal Code","description":"Postal code where the scan or click happened (if tracked)","example":"94304"},"city":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"City","description":"City where the scan or click happened (if tracked)","example":"Palo Alto"},"browser":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Browser","description":"Browser name","example":"Firefox"},"browser_version":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Browser Version","description":"Browser version","example":"147"},"os":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Os","description":"Operating system","example":"Android"},"os_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Os Version","description":"OS version","example":"15"},"time_zone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Time Zone","description":"Timezone of the scan or click","example":"America/New_York"},"brand":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Brand","description":"Device brand","example":"Samsung"},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model","description":"Device model","example":"Galaxy A55 5G"}},"type":"object","title":"ScanStatItem"},"SortOrder":{"type":"string","enum":["ASC","DESC"],"title":"SortOrder"},"TagsOut":{"properties":{"code":{"type":"string","title":"Code","description":"The code of the QR code (either provided vanity code or randomly generated code if not provided).","example":"easter-promotion-2"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"Tags of the QR code.","example":["tag1","tag2"]}},"type":"object","title":"TagsOut"},"TagsPatch":{"properties":{"tags_to_add":{"items":{"type":"string"},"type":"array","title":"Tags To Add","description":"Tags to add to the QR code.","example":["tag1","tag2"]},"tags_to_remove":{"items":{"type":"string"},"type":"array","title":"Tags To Remove","description":"Tags to remove from the QR code.","example":["tag1","tag2"]}},"type":"object","title":"TagsPatch"},"TypeChangeRequest":{"properties":{"type":{"type":"string","enum":["URL","BUSINESS_CARD","PRODUCT","OPENIMMO","COUPON","PLAIN","POSTER","SYNC","LEAD","SOCIAL","TRACING"],"title":"Type","description":"This is the QR Code type (default is URL). Allowed values: ['URL', 'BUSINESS_CARD', 'PRODUCT', 'OPENIMMO', 'COUPON', 'PLAIN', 'POSTER', 'SYNC', 'LEAD', 'SOCIAL', 'TRACING']","default":"URL"},"target_url":{"type":"string","title":"Target Url","description":"The target url the dynamic QR code redirects to.","example":"https://test.de"}},"type":"object","title":"TypeChangeRequest"},"TypeChangeResponse":{"properties":{"code":{"type":"string","title":"Code","description":"The code of the QR code (either provided vanity code or randomly generated code if not provided).","example":"easter-promotion-2"},"type":{"type":"string","enum":["URL","BUSINESS_CARD","PRODUCT","OPENIMMO","COUPON","PLAIN","POSTER","SYNC","LEAD","SOCIAL","TRACING"],"title":"Type","description":"This is the QR Code type (default is URL). Allowed values: ['URL', 'BUSINESS_CARD', 'PRODUCT', 'OPENIMMO', 'COUPON', 'PLAIN', 'POSTER', 'SYNC', 'LEAD', 'SOCIAL', 'TRACING']","default":"URL"},"target_url":{"type":"string","title":"Target Url","description":"The target url the dynamic QR code redirects to.","example":"https://test.de"}},"type":"object","title":"TypeChangeResponse"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"app__api__v2__schemas__folders__ScanStatSummary":{"properties":{"id":{"type":"string","title":"Id","description":"Unique identifier of a folder.","example":"12345"},"name":{"type":"string","title":"Name","description":"Name of a folder.","example":"XMAS Promotion"},"first_scan_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"First Scan At","description":"The date and time of the first scan of QR codes in the folder.","example":"2025-09-15 15:22:09"},"last_scan_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Scan At","description":"The date and time of the last scan of QR codes in the folder.","example":"2025-09-15 15:22:09"},"days_between_first_and_last_scan":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Days Between First And Last Scan","description":"The number of days between the first and last time the QR code has been scanned or clicked on the Short URL.","example":12},"scan_count":{"type":"integer","title":"Scan Count","description":"The number of times the QR code has been scanned or clicked on the Short URL.","example":12},"scan_count_per_day_first_last":{"type":"number","title":"Scan Count Per Day First Last","description":"The number of times per day on average the QR code has been scanned or clicked on the Short URL (between first and last scan date).","example":12.3}},"type":"object","title":"ScanStatSummary"},"app__api__v2__schemas__qrcodes__ScanStatSummary":{"properties":{"code":{"type":"string","title":"Code","description":"The code of the QR code (either provided vanity code or randomly generated code if not provided).","example":"easter-promotion-2"},"short_url":{"type":"string","title":"Short Url","description":"This is the URL where your QR Code is reachable. You can use this URL as an alternative of scanning the QR code - eg. if you want to use it in a social media post.","example":"https://qr.yourdomain.com/easter-promotion-2"},"target_url":{"type":"string","title":"Target Url","description":"The target url the dynamic QR code redirects to.","example":"https://test.de"},"type":{"type":"string","enum":["URL","BUSINESS_CARD","PRODUCT","OPENIMMO","COUPON","PLAIN","POSTER","SYNC","LEAD","SOCIAL","TRACING"],"title":"Type","description":"This is the QR Code type (default is URL). Allowed values: ['URL', 'BUSINESS_CARD', 'PRODUCT', 'OPENIMMO', 'COUPON', 'PLAIN', 'POSTER', 'SYNC', 'LEAD', 'SOCIAL', 'TRACING']","default":"URL"},"subtype":{"anyOf":[{"type":"string"},{"type":"null"}],"enum":["URL","FACEBOOK_PAGE","FACEBOOK_LIKE","INSTAGRAM","SKYPE","APPSTORE","YOUTUBE","TWITTER","LINKEDIN","SMS","EMAIL","TEXT","VCARD","WLAN","GEO","PAYPAL","PINTEREST","GOOGLEPLUS","EVENT","PHONE","SEPA","MULTI","BITCOIN","VOUCHER","WHATSAPP","PDF","MULTI_LANGUAGE","MP3","MULTI_GEO","MULTI_GEO_CLOSEST","MULTI_REGION","UNLIMITED","UNIQUEIP","UNIQUEID","ONE","GS1"],"title":"Subtype","description":"This is the QR Code subtype. Allowed values: ['URL', 'FACEBOOK_PAGE', 'FACEBOOK_LIKE', 'INSTAGRAM', 'SKYPE', 'APPSTORE', 'YOUTUBE', 'TWITTER', 'LINKEDIN', 'SMS', 'EMAIL', 'TEXT', 'VCARD', 'WLAN', 'GEO', 'PAYPAL', 'PINTEREST', 'GOOGLEPLUS', 'EVENT', 'PHONE', 'SEPA', 'MULTI', 'BITCOIN', 'VOUCHER', 'WHATSAPP', 'PDF', 'MULTI_LANGUAGE', 'MP3', 'MULTI_GEO', 'MULTI_GEO_CLOSEST', 'MULTI_REGION', 'UNLIMITED', 'UNIQUEIP', 'UNIQUEID', 'ONE', 'GS1']","default":""},"location":{"additionalProperties":true,"type":"object","title":"Location","description":"Geodata can be transmitted with each QR code. This could be, for example, the company's website address or any location where the QR code is placed. The `address` parameter is a human-readable address. The `lat` (latitude) and `lng` (longitude) parameters are intended for automated processing, such as displaying the location on a map. The `image` parameter allows you to specify the path to a suitable image.","example":{"address":"Times Square, New York, NY 10036, USA","lat":40.758,"lng":-73.9855}},"creation_at":{"type":"string","format":"date-time","title":"Creation At","description":"The creation date and time for the QR code.","example":"2025-09-01T11:11:11"},"first_scan_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"First Scan At","description":"The date and time of the first scan of the QR code.","example":"2025-09-01T11:11:11"},"last_scan_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Scan At","description":"The date and time of the last scan of the QR code.","example":"2025-09-15T15:15:15"},"days_between_first_and_last_scan":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Days Between First And Last Scan","description":"The number of days between the first and last time the QR code has been scanned or clicked on the Short URL.","example":12},"days_since_created":{"type":"integer","title":"Days Since Created","description":"The number of days since the QR code has been created.","example":117},"scan_count":{"type":"integer","title":"Scan Count","description":"The number of times the QR code has been scanned or clicked on the Short URL.","example":12},"unique_visitor_count":{"type":"integer","title":"Unique Visitor Count","description":"The number of unique visitors that scanned the QR Code or clicked on the Short URL.","example":10},"scan_count_per_day_since_creation":{"type":"number","title":"Scan Count Per Day Since Creation","description":"The number of times per day on average the QR code has been scanned or clicked on the Short URL (since its creation).","example":5.3},"scan_count_per_day_first_last":{"type":"number","title":"Scan Count Per Day First Last","description":"The number of times per day on average the QR code has been scanned or clicked on the Short URL (between first and last scan date).","example":12.3}},"type":"object","title":"ScanStatSummary"}},"securitySchemes":{"HTTPBearer":{"type":"http","description":"Provide your API credentials key here, either `public:yourdomain.com:XXXXX:YYYYY` or `secret:yourdomain.com:XXXXX:YYYYY`. The secret API key can be used for every endpoint. Use it only in server-to-server communication. The public API key may be used for asynchronous GET requests in the browser (client-server communication via Javascript).","scheme":"bearer"}}},"tags":[{"name":"QR Codes","description":"In this area you find all the API endpoints to manage your QR codes:\n- create, get details, change and delete a QR code\n- list your QR codes\n- get and remove country/language based QR code target urls\n- get and reset statistics of the scans of your QR codes\n- add and remove tags from your QR code\n- download plain and designer images of QR codes\n- etc.\n"},{"name":"Folders","description":"In this area you find all the API endpoints to manage your QR code folders:\n- create, delete and list your folders\n- get and reset statistics of your QR code folders.\n"},{"name":"Geo Fencing","description":"Geofencing is a technique that uses a user's GPS location (country, language, etc.) to trigger a location-based action.\n\nFor example, a user receives a notification when they are within a specific area (geofence).\n\nA geofencing QR code is a type of QR code that redirects the user to a specific URL based on their GPS location. You can define these geofences using GPS coordinates, within which the user must be to be redirected to a particular URL.\n\nThe user must always give their consent before their GPS location is transmitted. If no GPS location is received, a default URL can be set to which the user will be redirected.\n\nTo list all the already created Geofencing rules you can get this information from the regular GET QR code endpoint.\n"},{"name":"Coupons","description":"The Coupons API (v2) lets you manage and operate QR-based coupon campaigns programmatically: you can list all coupons in your account with simple pagination (page, size), issue a new voucher for a specific coupon code (optionally assigning it to an issuing group and setting a ttl so unredeemed vouchers expire and are deleted), and retrieve both issue stats (how many vouchers exist, how many are issued/available/redeemed, plus first/last redemption timestamps) and redemption logs as a paginated feed for reporting and audits. All endpoints are secured via HTTP Bearer authentication.\n\n- List coupons (paginated): fetch coupons in your account using page + size\n- Issue a voucher: generate a unique voucher_code for a given coupon code, with optional group and ttl\n- Use ready-to-display URLs: get the coupon landing/redemption URL plus QR image URLs for redemption and immediate redemption\n- Monitor availability: retrieve totals, issued/available counts, redeemed counts, and first/last redemption times\n- Review redemptions (paginated): pull redemption statistics/logs with page + size for analytics and reconciliation\n"},{"name":"GS1 Digital Link","description":"\nWith the GS1 Digital Link API you are able to create dynamic GS1 QR Codes and retrieve scanning statistics about each of your QR Codes.\n\nYou can manipulate GS1 Digital Link QR Codes (delete, get and reset stats, add/remove tags, download, etc.) via the Standard QR Code API.\n\nNote: please make sure to provide the code you received after creating the GS1 QR Code (a hash-value) as the `code` parameter to the standard API calls. \n"},{"name":"Designer Templates","description":"\nThe Designer Templates API lets you browse and retrieve QR Designer templates that can be used to generate Designer QR codes (see `/download-image/designer`). \n\n- List templates (paginated): get all templates available in your account with page/size\n- Get template by id: fetch a single template with metadata and a sample preview URL\n"},{"name":"Analytics","description":"\nThe Analytics API gives you access to scan and redemption insights across QR codes, folders, and coupons.\nYou can fetch summary statistics, detailed event lists, and reset counters where supported.\n\n- QR Code stats: get scan summary + paginated scan events for a QR code (`GET /qrcodes/{code}/stats`)\n- Reset QR Code stats: reset scan counters for a QR code (`POST /qrcodes/{code}/stats/reset`)\n- Folder stats: get aggregate scan stats for all QR codes in a folder (`GET /folders/{folder_id}/stats`)\n- Reset Folder stats: reset scan counters for a folder (`POST /folders/{folder_id}/stats/reset`)\n- Coupon issue stats: totals/issued/available/redeemed + first/last redemption (`GET /coupons/{code}/stats`)\n- Coupon redemption logs: paginated redemption events for a coupon (`GET /coupons/{code}/redemptions`)\n\nMost stats endpoints support filtering by country and date ranges where applicable.\n"},{"name":"Tags","description":"\nThe Tags API lets you manage tag labels for individual QR codes.\n\n- Get tags: list all tags assigned to a QR code (`GET /qrcodes/{code}/tags`)\n- Change tags: add/remove tags in a single request (`PATCH /qrcodes/{code}/tags`)\n- Delete tags: remove all tags from a QR code (`DELETE /qrcodes/{code}/tags`)\n"},{"name":"Leads","description":"\nThe Leads API lets you fetch leads collected by landing page QR codes.\nYou can retrieve a paginated list of leads or export the full dataset as CSV/XLSX.\n\n- Get leads: list leads for a landing page QR code (`GET /qrcodes/{code}/leads`)\n- Filter by referrer: restrict leads to a specific referrer URL\n- Export formats: JSON (paginated), CSV, or XLSX (full export)\n- CSV options: custom delimiter and decimal separator\n"},{"name":"Digital Business Cards","description":"\nThe Digital Business Cards API lets you manage your digital business cards and related assets.\n\n- List cards (paginated): fetch all Digital Business Cards in your account (`GET /business-cards`)\n- Get card: retrieve a single card by code (`GET /business-cards/{code}`)\n- Create card: create a new Digital Business Card (`POST /business-cards`)\n- Update card: change selected fields (`PATCH /business-cards/{code}`)\n- Upload images: upload user, logo, or background image (`POST /business-cards/{code}/images/{kind}`)\n- Delete card: remove a card (`DELETE /business-cards/{code}`)\n"}]}