{ "item": [ { "name": "forms", "description": "", "item": [ { "id": "dbebb5e4-c3ca-4fdb-a459-0f9d147fc0b6", "name": "List forms", "request": { "name": "List forms", "description": { "content": "Paginated list of forms on your account. Guide: [Manage Forms](https://docs.form-qr-code-generator.com/v1/index.htm#manage-forms).", "type": "text/plain" }, "url": { "path": [ "forms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page index (1-based). Default: 1.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Page size (forms per page). Default: 5.", "type": "text/plain" }, "key": "limit", "value": "5" }, { "disabled": false, "description": { "content": "If true, list archived forms instead of active ones.", "type": "text/plain" }, "key": "archive", "value": "false" }, { "disabled": false, "description": { "content": "Sort order: `1` = newest first (`createdAt` desc), `2` = by name (A→Z), `3` = by scan count desc. (This can only be one of 1,2,3)", "type": "text/plain" }, "key": "sort", "value": "1" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "8e86d2a1-d248-4434-bcff-820f84cf6919", "name": "Success", "originalRequest": { "url": { "path": [ "forms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page index (1-based). Default: 1.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Page size (forms per page). Default: 5.", "type": "text/plain" }, "key": "limit", "value": "5" }, { "disabled": false, "description": { "content": "If true, list archived forms instead of active ones.", "type": "text/plain" }, "key": "archive", "value": "false" }, { "disabled": false, "description": { "content": "Sort order: `1` = newest first (`createdAt` desc), `2` = by name (A→Z), `3` = by scan count desc. (This can only be one of 1,2,3)", "type": "text/plain" }, "key": "sort", "value": "1" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"items\": [\n {\n \"id\": \"\",\n \"qrId\": \"\",\n \"title\": \"\",\n \"shortText\": \"\",\n \"shortUrl\": \"\",\n \"previewImage\": \"\",\n \"qrImage\": \"\",\n \"svgQrImage\": \"\",\n \"scans\": \"\",\n \"submissions\": \"\",\n \"active\": \"\",\n \"starred\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"qrId\": \"\",\n \"title\": \"\",\n \"shortText\": \"\",\n \"shortUrl\": \"\",\n \"previewImage\": \"\",\n \"qrImage\": \"\",\n \"svgQrImage\": \"\",\n \"scans\": \"\",\n \"submissions\": \"\",\n \"active\": \"\",\n \"starred\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"total\": \"\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\"\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cf56c85-9114-4363-9722-29ded1ae0e92", "name": "Invalid request or server validation error", "originalRequest": { "url": { "path": [ "forms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page index (1-based). Default: 1.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Page size (forms per page). Default: 5.", "type": "text/plain" }, "key": "limit", "value": "5" }, { "disabled": false, "description": { "content": "If true, list archived forms instead of active ones.", "type": "text/plain" }, "key": "archive", "value": "false" }, { "disabled": false, "description": { "content": "Sort order: `1` = newest first (`createdAt` desc), `2` = by name (A→Z), `3` = by scan count desc. (This can only be one of 1,2,3)", "type": "text/plain" }, "key": "sort", "value": "1" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a090b391-ac1e-4fd5-b270-8b21ffd5bd6b", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "forms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page index (1-based). Default: 1.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Page size (forms per page). Default: 5.", "type": "text/plain" }, "key": "limit", "value": "5" }, { "disabled": false, "description": { "content": "If true, list archived forms instead of active ones.", "type": "text/plain" }, "key": "archive", "value": "false" }, { "disabled": false, "description": { "content": "Sort order: `1` = newest first (`createdAt` desc), `2` = by name (A→Z), `3` = by scan count desc. (This can only be one of 1,2,3)", "type": "text/plain" }, "key": "sort", "value": "1" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8b69cd0-418c-4526-9c0e-da1359f119da", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "forms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page index (1-based). Default: 1.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Page size (forms per page). Default: 5.", "type": "text/plain" }, "key": "limit", "value": "5" }, { "disabled": false, "description": { "content": "If true, list archived forms instead of active ones.", "type": "text/plain" }, "key": "archive", "value": "false" }, { "disabled": false, "description": { "content": "Sort order: `1` = newest first (`createdAt` desc), `2` = by name (A→Z), `3` = by scan count desc. (This can only be one of 1,2,3)", "type": "text/plain" }, "key": "sort", "value": "1" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91ed268a-cae0-4b74-bd44-db7d9a1e6dbd", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "forms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page index (1-based). Default: 1.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Page size (forms per page). Default: 5.", "type": "text/plain" }, "key": "limit", "value": "5" }, { "disabled": false, "description": { "content": "If true, list archived forms instead of active ones.", "type": "text/plain" }, "key": "archive", "value": "false" }, { "disabled": false, "description": { "content": "Sort order: `1` = newest first (`createdAt` desc), `2` = by name (A→Z), `3` = by scan count desc. (This can only be one of 1,2,3)", "type": "text/plain" }, "key": "sort", "value": "1" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "956c20ac-5cb5-441d-9ebc-b7d45ea07ac9", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "forms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page index (1-based). Default: 1.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Page size (forms per page). Default: 5.", "type": "text/plain" }, "key": "limit", "value": "5" }, { "disabled": false, "description": { "content": "If true, list archived forms instead of active ones.", "type": "text/plain" }, "key": "archive", "value": "false" }, { "disabled": false, "description": { "content": "Sort order: `1` = newest first (`createdAt` desc), `2` = by name (A→Z), `3` = by scan count desc. (This can only be one of 1,2,3)", "type": "text/plain" }, "key": "sort", "value": "1" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ef58cd09-1ed4-4f02-a95c-ff2607bb6ff9", "name": "Create form", "request": { "name": "Create form", "description": { "content": "Create a new form (`title`, `shortText`, `fields`). Viewer role → **403**. Sending existing `qrId` in body updates that form (legacy) — prefer **PUT**. Guide: [Create a Form](https://docs.form-qr-code-generator.com/v1/index.htm#create-form).", "type": "text/plain" }, "url": { "path": [ "forms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"shortText\": \"\",\n \"fields\": [\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n },\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n }\n ],\n \"backgroundType\": \"solid\",\n \"backgroundColor1\": \"0076d7\",\n \"backgroundColor2\": \"3a74c5\",\n \"appearance\": {\n \"headerColor\": \"ffffff\",\n \"buttonColor\": \"ffffff\"\n },\n \"logo\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backgroundImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backdrop\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"previewImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"qrConfig\": {\n \"backgroundColor\": \"\",\n \"colorDark\": \"\",\n \"eye_inner\": \"eyeInner7\",\n \"eye_outer\": \"eyeOuter2\",\n \"logo\": \"\",\n \"qrData\": \"pattern8\",\n \"size\": \"\",\n \"transparentBkg\": \"\",\n \"gradient\": \"\",\n \"grdType\": \"radial\",\n \"color01\": \"\",\n \"color02\": \"\",\n \"eye_color\": \"\",\n \"eye_color01\": \"\",\n \"eye_color02\": \"\",\n \"frame\": 3,\n \"frameText\": \"\",\n \"frameTextFont\": \"PT Sans\",\n \"frameColor\": \"\",\n \"frameColor2\": \"\",\n \"frameColorType\": \"fill\",\n \"frameGradientStartColor\": \"\",\n \"frameGradientEndColor\": \"\"\n },\n \"isQuiz\": false,\n \"quizConfig\": {\n \"passingScore\": 70,\n \"distributeMarksEvenly\": \"\",\n \"enableTimeLimit\": \"\",\n \"timeLimit\": 1800,\n \"shuffleQuestions\": \"\",\n \"showFinalScore\": \"\",\n \"showAnswersResults\": \"\",\n \"stepByStep\": \"\",\n \"passMessage\": \"\",\n \"failMessage\": \"\",\n \"timeUpMessage\": \"\"\n },\n \"submissionNotification\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9e83ef94-eb75-4143-8c1b-284ac2c0cf89", "name": "Form created or draft updated", "originalRequest": { "url": { "path": [ "forms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"shortText\": \"\",\n \"fields\": [\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n },\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n }\n ],\n \"backgroundType\": \"solid\",\n \"backgroundColor1\": \"0076d7\",\n \"backgroundColor2\": \"3a74c5\",\n \"appearance\": {\n \"headerColor\": \"ffffff\",\n \"buttonColor\": \"ffffff\"\n },\n \"logo\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backgroundImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backdrop\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"previewImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"qrConfig\": {\n \"backgroundColor\": \"\",\n \"colorDark\": \"\",\n \"eye_inner\": \"eyeInner7\",\n \"eye_outer\": \"eyeOuter2\",\n \"logo\": \"\",\n \"qrData\": \"pattern8\",\n \"size\": \"\",\n \"transparentBkg\": \"\",\n \"gradient\": \"\",\n \"grdType\": \"radial\",\n \"color01\": \"\",\n \"color02\": \"\",\n \"eye_color\": \"\",\n \"eye_color01\": \"\",\n \"eye_color02\": \"\",\n \"frame\": 3,\n \"frameText\": \"\",\n \"frameTextFont\": \"PT Sans\",\n \"frameColor\": \"\",\n \"frameColor2\": \"\",\n \"frameColorType\": \"fill\",\n \"frameGradientStartColor\": \"\",\n \"frameGradientEndColor\": \"\"\n },\n \"isQuiz\": false,\n \"quizConfig\": {\n \"passingScore\": 70,\n \"distributeMarksEvenly\": \"\",\n \"enableTimeLimit\": \"\",\n \"timeLimit\": 1800,\n \"shuffleQuestions\": \"\",\n \"showFinalScore\": \"\",\n \"showAnswersResults\": \"\",\n \"stepByStep\": \"\",\n \"passMessage\": \"\",\n \"failMessage\": \"\",\n \"timeUpMessage\": \"\"\n },\n \"submissionNotification\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"id\": \"\",\n \"qrId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"shortText\": \"\",\n \"shortUrl\": \"\",\n \"previewImage\": \"\",\n \"qrImage\": \"\",\n \"svgQrImage\": \"\",\n \"scans\": \"\",\n \"submissions\": \"\",\n \"active\": \"\",\n \"fields\": [\n {\n \"key\": \"\",\n \"type\": \"\",\n \"option\": {\n \"key_0\": \"string\"\n },\n \"quizConfig\": {\n \"key_0\": false\n }\n },\n {\n \"key\": \"\",\n \"type\": \"\",\n \"option\": {\n \"key_0\": true,\n \"key_1\": 490.8926043062012,\n \"key_2\": 4520,\n \"key_3\": 1971.2316974008504\n },\n \"quizConfig\": {\n \"key_0\": \"string\"\n }\n }\n ],\n \"qrConfig\": {\n \"backgroundColor\": \"\",\n \"colorDark\": \"\",\n \"eye_inner\": \"eyeInner5\",\n \"eye_outer\": \"eyeOuter1\",\n \"logo\": \"\",\n \"qrCategory\": \"\",\n \"qrData\": \"pattern13\",\n \"size\": \"\",\n \"transparentBkg\": \"\",\n \"gradient\": \"\",\n \"grdType\": \"radial\",\n \"color01\": \"\",\n \"color02\": \"\",\n \"eye_color\": \"\",\n \"eye_color01\": \"\",\n \"eye_color02\": \"\",\n \"frame\": 12,\n \"frameText\": \"\",\n \"frameTextFont\": \"Verdana\",\n \"frameColor\": \"\",\n \"frameColor2\": \"\",\n \"frameColorType\": \"diagonal1\",\n \"frameGradientStartColor\": \"\",\n \"frameGradientEndColor\": \"\"\n },\n \"isQuiz\": \"\",\n \"quizConfig\": {\n \"passingScore\": 70,\n \"distributeMarksEvenly\": \"\",\n \"enableTimeLimit\": \"\",\n \"timeLimit\": 1800,\n \"shuffleQuestions\": \"\",\n \"showFinalScore\": \"\",\n \"showAnswersResults\": \"\",\n \"stepByStep\": \"\",\n \"passMessage\": \"\",\n \"failMessage\": \"\",\n \"timeUpMessage\": \"\"\n },\n \"submissionNotification\": true,\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8b26267-cbe0-4ccc-a336-3179496733e8", "name": "Validation error, GPS config error, QR generation failure, or other bad input", "originalRequest": { "url": { "path": [ "forms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"shortText\": \"\",\n \"fields\": [\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n },\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n }\n ],\n \"backgroundType\": \"solid\",\n \"backgroundColor1\": \"0076d7\",\n \"backgroundColor2\": \"3a74c5\",\n \"appearance\": {\n \"headerColor\": \"ffffff\",\n \"buttonColor\": \"ffffff\"\n },\n \"logo\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backgroundImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backdrop\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"previewImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"qrConfig\": {\n \"backgroundColor\": \"\",\n \"colorDark\": \"\",\n \"eye_inner\": \"eyeInner7\",\n \"eye_outer\": \"eyeOuter2\",\n \"logo\": \"\",\n \"qrData\": \"pattern8\",\n \"size\": \"\",\n \"transparentBkg\": \"\",\n \"gradient\": \"\",\n \"grdType\": \"radial\",\n \"color01\": \"\",\n \"color02\": \"\",\n \"eye_color\": \"\",\n \"eye_color01\": \"\",\n \"eye_color02\": \"\",\n \"frame\": 3,\n \"frameText\": \"\",\n \"frameTextFont\": \"PT Sans\",\n \"frameColor\": \"\",\n \"frameColor2\": \"\",\n \"frameColorType\": \"fill\",\n \"frameGradientStartColor\": \"\",\n \"frameGradientEndColor\": \"\"\n },\n \"isQuiz\": false,\n \"quizConfig\": {\n \"passingScore\": 70,\n \"distributeMarksEvenly\": \"\",\n \"enableTimeLimit\": \"\",\n \"timeLimit\": 1800,\n \"shuffleQuestions\": \"\",\n \"showFinalScore\": \"\",\n \"showAnswersResults\": \"\",\n \"stepByStep\": \"\",\n \"passMessage\": \"\",\n \"failMessage\": \"\",\n \"timeUpMessage\": \"\"\n },\n \"submissionNotification\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "853e6193-51e2-401b-a81a-1daa55905ec9", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "forms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"shortText\": \"\",\n \"fields\": [\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n },\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n }\n ],\n \"backgroundType\": \"solid\",\n \"backgroundColor1\": \"0076d7\",\n \"backgroundColor2\": \"3a74c5\",\n \"appearance\": {\n \"headerColor\": \"ffffff\",\n \"buttonColor\": \"ffffff\"\n },\n \"logo\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backgroundImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backdrop\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"previewImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"qrConfig\": {\n \"backgroundColor\": \"\",\n \"colorDark\": \"\",\n \"eye_inner\": \"eyeInner7\",\n \"eye_outer\": \"eyeOuter2\",\n \"logo\": \"\",\n \"qrData\": \"pattern8\",\n \"size\": \"\",\n \"transparentBkg\": \"\",\n \"gradient\": \"\",\n \"grdType\": \"radial\",\n \"color01\": \"\",\n \"color02\": \"\",\n \"eye_color\": \"\",\n \"eye_color01\": \"\",\n \"eye_color02\": \"\",\n \"frame\": 3,\n \"frameText\": \"\",\n \"frameTextFont\": \"PT Sans\",\n \"frameColor\": \"\",\n \"frameColor2\": \"\",\n \"frameColorType\": \"fill\",\n \"frameGradientStartColor\": \"\",\n \"frameGradientEndColor\": \"\"\n },\n \"isQuiz\": false,\n \"quizConfig\": {\n \"passingScore\": 70,\n \"distributeMarksEvenly\": \"\",\n \"enableTimeLimit\": \"\",\n \"timeLimit\": 1800,\n \"shuffleQuestions\": \"\",\n \"showFinalScore\": \"\",\n \"showAnswersResults\": \"\",\n \"stepByStep\": \"\",\n \"passMessage\": \"\",\n \"failMessage\": \"\",\n \"timeUpMessage\": \"\"\n },\n \"submissionNotification\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32cbb796-c8cd-48e6-b5e3-74f704a54355", "name": "Authenticated but not allowed for this action. Common cases: **Viewer** on `POST /forms`; **Editor** or **Viewer** on account webhook routes; **Editor** or **Viewer** on team management routes. See guide [Core Concepts](https://docs.form-qr-code-generator.com/v1/index.htm#core-concepts).", "originalRequest": { "url": { "path": [ "forms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"shortText\": \"\",\n \"fields\": [\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n },\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n }\n ],\n \"backgroundType\": \"solid\",\n \"backgroundColor1\": \"0076d7\",\n \"backgroundColor2\": \"3a74c5\",\n \"appearance\": {\n \"headerColor\": \"ffffff\",\n \"buttonColor\": \"ffffff\"\n },\n \"logo\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backgroundImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backdrop\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"previewImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"qrConfig\": {\n \"backgroundColor\": \"\",\n \"colorDark\": \"\",\n \"eye_inner\": \"eyeInner7\",\n \"eye_outer\": \"eyeOuter2\",\n \"logo\": \"\",\n \"qrData\": \"pattern8\",\n \"size\": \"\",\n \"transparentBkg\": \"\",\n \"gradient\": \"\",\n \"grdType\": \"radial\",\n \"color01\": \"\",\n \"color02\": \"\",\n \"eye_color\": \"\",\n \"eye_color01\": \"\",\n \"eye_color02\": \"\",\n \"frame\": 3,\n \"frameText\": \"\",\n \"frameTextFont\": \"PT Sans\",\n \"frameColor\": \"\",\n \"frameColor2\": \"\",\n \"frameColorType\": \"fill\",\n \"frameGradientStartColor\": \"\",\n \"frameGradientEndColor\": \"\"\n },\n \"isQuiz\": false,\n \"quizConfig\": {\n \"passingScore\": 70,\n \"distributeMarksEvenly\": \"\",\n \"enableTimeLimit\": \"\",\n \"timeLimit\": 1800,\n \"shuffleQuestions\": \"\",\n \"showFinalScore\": \"\",\n \"showAnswersResults\": \"\",\n \"stepByStep\": \"\",\n \"passMessage\": \"\",\n \"failMessage\": \"\",\n \"timeUpMessage\": \"\"\n },\n \"submissionNotification\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7136c7af-beba-4f54-9cac-8492d8a68855", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "forms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"shortText\": \"\",\n \"fields\": [\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n },\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n }\n ],\n \"backgroundType\": \"solid\",\n \"backgroundColor1\": \"0076d7\",\n \"backgroundColor2\": \"3a74c5\",\n \"appearance\": {\n \"headerColor\": \"ffffff\",\n \"buttonColor\": \"ffffff\"\n },\n \"logo\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backgroundImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backdrop\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"previewImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"qrConfig\": {\n \"backgroundColor\": \"\",\n \"colorDark\": \"\",\n \"eye_inner\": \"eyeInner7\",\n \"eye_outer\": \"eyeOuter2\",\n \"logo\": \"\",\n \"qrData\": \"pattern8\",\n \"size\": \"\",\n \"transparentBkg\": \"\",\n \"gradient\": \"\",\n \"grdType\": \"radial\",\n \"color01\": \"\",\n \"color02\": \"\",\n \"eye_color\": \"\",\n \"eye_color01\": \"\",\n \"eye_color02\": \"\",\n \"frame\": 3,\n \"frameText\": \"\",\n \"frameTextFont\": \"PT Sans\",\n \"frameColor\": \"\",\n \"frameColor2\": \"\",\n \"frameColorType\": \"fill\",\n \"frameGradientStartColor\": \"\",\n \"frameGradientEndColor\": \"\"\n },\n \"isQuiz\": false,\n \"quizConfig\": {\n \"passingScore\": 70,\n \"distributeMarksEvenly\": \"\",\n \"enableTimeLimit\": \"\",\n \"timeLimit\": 1800,\n \"shuffleQuestions\": \"\",\n \"showFinalScore\": \"\",\n \"showAnswersResults\": \"\",\n \"stepByStep\": \"\",\n \"passMessage\": \"\",\n \"failMessage\": \"\",\n \"timeUpMessage\": \"\"\n },\n \"submissionNotification\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76b97280-36da-4191-b752-39e5399d7b0d", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "forms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"shortText\": \"\",\n \"fields\": [\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n },\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n }\n ],\n \"backgroundType\": \"solid\",\n \"backgroundColor1\": \"0076d7\",\n \"backgroundColor2\": \"3a74c5\",\n \"appearance\": {\n \"headerColor\": \"ffffff\",\n \"buttonColor\": \"ffffff\"\n },\n \"logo\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backgroundImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backdrop\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"previewImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"qrConfig\": {\n \"backgroundColor\": \"\",\n \"colorDark\": \"\",\n \"eye_inner\": \"eyeInner7\",\n \"eye_outer\": \"eyeOuter2\",\n \"logo\": \"\",\n \"qrData\": \"pattern8\",\n \"size\": \"\",\n \"transparentBkg\": \"\",\n \"gradient\": \"\",\n \"grdType\": \"radial\",\n \"color01\": \"\",\n \"color02\": \"\",\n \"eye_color\": \"\",\n \"eye_color01\": \"\",\n \"eye_color02\": \"\",\n \"frame\": 3,\n \"frameText\": \"\",\n \"frameTextFont\": \"PT Sans\",\n \"frameColor\": \"\",\n \"frameColor2\": \"\",\n \"frameColorType\": \"fill\",\n \"frameGradientStartColor\": \"\",\n \"frameGradientEndColor\": \"\"\n },\n \"isQuiz\": false,\n \"quizConfig\": {\n \"passingScore\": 70,\n \"distributeMarksEvenly\": \"\",\n \"enableTimeLimit\": \"\",\n \"timeLimit\": 1800,\n \"shuffleQuestions\": \"\",\n \"showFinalScore\": \"\",\n \"showAnswersResults\": \"\",\n \"stepByStep\": \"\",\n \"passMessage\": \"\",\n \"failMessage\": \"\",\n \"timeUpMessage\": \"\"\n },\n \"submissionNotification\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08cf3e6e-ff4a-40dd-90fd-a1fa5ff53e67", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "forms" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"shortText\": \"\",\n \"fields\": [\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n },\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n }\n ],\n \"backgroundType\": \"solid\",\n \"backgroundColor1\": \"0076d7\",\n \"backgroundColor2\": \"3a74c5\",\n \"appearance\": {\n \"headerColor\": \"ffffff\",\n \"buttonColor\": \"ffffff\"\n },\n \"logo\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backgroundImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backdrop\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"previewImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"qrConfig\": {\n \"backgroundColor\": \"\",\n \"colorDark\": \"\",\n \"eye_inner\": \"eyeInner7\",\n \"eye_outer\": \"eyeOuter2\",\n \"logo\": \"\",\n \"qrData\": \"pattern8\",\n \"size\": \"\",\n \"transparentBkg\": \"\",\n \"gradient\": \"\",\n \"grdType\": \"radial\",\n \"color01\": \"\",\n \"color02\": \"\",\n \"eye_color\": \"\",\n \"eye_color01\": \"\",\n \"eye_color02\": \"\",\n \"frame\": 3,\n \"frameText\": \"\",\n \"frameTextFont\": \"PT Sans\",\n \"frameColor\": \"\",\n \"frameColor2\": \"\",\n \"frameColorType\": \"fill\",\n \"frameGradientStartColor\": \"\",\n \"frameGradientEndColor\": \"\"\n },\n \"isQuiz\": false,\n \"quizConfig\": {\n \"passingScore\": 70,\n \"distributeMarksEvenly\": \"\",\n \"enableTimeLimit\": \"\",\n \"timeLimit\": 1800,\n \"shuffleQuestions\": \"\",\n \"showFinalScore\": \"\",\n \"showAnswersResults\": \"\",\n \"stepByStep\": \"\",\n \"passMessage\": \"\",\n \"failMessage\": \"\",\n \"timeUpMessage\": \"\"\n },\n \"submissionNotification\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d7b22584-bf20-4ea2-af22-74251bdcdc2b", "name": "Delete multiple forms", "request": { "name": "Delete multiple forms", "description": { "content": "Delete forms you own. Pass `ids` as repeated query params (`?ids=A&ids=B`). Viewer cannot delete.", "type": "text/plain" }, "url": { "path": [ "forms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Form ids (`qrId`) to delete; repeat the query param for each id (e.g. `?ids=ABC&ids=DEF`). At least one non-empty value is required.", "type": "text/plain" }, "key": "ids", "value": "" }, { "disabled": false, "description": { "content": "(Required) Form ids (`qrId`) to delete; repeat the query param for each id (e.g. `?ids=ABC&ids=DEF`). At least one non-empty value is required.", "type": "text/plain" }, "key": "ids", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7a4fc792-d243-4431-bd69-e86d9dec3ae3", "name": "Deletion completed", "originalRequest": { "url": { "path": [ "forms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Form ids (`qrId`) to delete; repeat the query param for each id (e.g. `?ids=ABC&ids=DEF`). At least one non-empty value is required.", "type": "text/plain" }, "key": "ids", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"message\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d381b532-4554-4db2-81c4-be52d473b4a0", "name": "Missing or empty **`ids`** query; **no matching** form ids; **permission denied** (e.g. **Viewer**, or **Editor** deleting another member's form); or other validation error.", "originalRequest": { "url": { "path": [ "forms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Form ids (`qrId`) to delete; repeat the query param for each id (e.g. `?ids=ABC&ids=DEF`). At least one non-empty value is required.", "type": "text/plain" }, "key": "ids", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c149019a-aebf-4080-b977-1759b5fd2e7e", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "forms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Form ids (`qrId`) to delete; repeat the query param for each id (e.g. `?ids=ABC&ids=DEF`). At least one non-empty value is required.", "type": "text/plain" }, "key": "ids", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dda67c71-7d4f-4975-ae59-30415f9015bb", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "forms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Form ids (`qrId`) to delete; repeat the query param for each id (e.g. `?ids=ABC&ids=DEF`). At least one non-empty value is required.", "type": "text/plain" }, "key": "ids", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c20b1e14-4816-48d2-b086-2f2a6ce5f834", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "forms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Form ids (`qrId`) to delete; repeat the query param for each id (e.g. `?ids=ABC&ids=DEF`). At least one non-empty value is required.", "type": "text/plain" }, "key": "ids", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56212b6a-09a8-45e8-ac61-f2da641c2d8b", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "forms" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Form ids (`qrId`) to delete; repeat the query param for each id (e.g. `?ids=ABC&ids=DEF`). At least one non-empty value is required.", "type": "text/plain" }, "key": "ids", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{qrId}", "description": "", "item": [ { "name": "submission-schema", "description": "", "item": [ { "id": "07644688-7d3f-4be2-a751-6baa6eb024c7", "name": "Get submission answer schema for a form", "request": { "name": "Get submission answer schema for a form", "description": { "content": "Field keys and `valueType` for building `answers`. Guide: [Create a Submission](https://docs.form-qr-code-generator.com/v1/index.htm#create-submission).", "type": "text/plain" }, "url": { "path": [ "forms", ":qrId", "submission-schema" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "TRYAWW447IK", "key": "qrId", "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9cf05c6c-9fd4-4186-9a06-2f3f05f60d12", "name": "Submission schema", "originalRequest": { "url": { "path": [ "forms", ":qrId", "submission-schema" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"qrId\": \"\",\n \"title\": \"\",\n \"fields\": {\n \"key_0\": {\n \"key\": \"\",\n \"type\": \"\",\n \"valueType\": \"fileId\",\n \"label\": \"\",\n \"required\": \"\",\n \"options\": [\n {\n \"value\": \"\",\n \"name\": \"\"\n },\n {\n \"value\": \"\",\n \"name\": \"\"\n }\n ]\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d1997f37-3fe2-4767-b2c2-c64050e1164e", "name": "Invalid `qrId` or form not accessible", "originalRequest": { "url": { "path": [ "forms", ":qrId", "submission-schema" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d79aeb41-0226-4141-a263-9d040e16404f", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "forms", ":qrId", "submission-schema" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a2ebf8d-e0d3-422c-bc98-807bad25fc15", "name": "Undocumented path", "originalRequest": { "url": { "path": [ "forms", ":qrId", "submission-schema" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8ebb001-7c04-4d2c-88cb-a1b32c84a0a5", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "forms", ":qrId", "submission-schema" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a22f2da2-7161-42f0-b2d4-3a1903e8f501", "name": "Unexpected server error", "originalRequest": { "url": { "path": [ "forms", ":qrId", "submission-schema" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "id": "75535e9e-b64a-446d-8604-75025db4c190", "name": "Get form by qrId", "request": { "name": "Get form by qrId", "description": { "content": "Form detail including `fields[].key`. Unknown qrId → **400**. Guide: [Manage Forms](https://docs.form-qr-code-generator.com/v1/index.htm#manage-forms).", "type": "text/plain" }, "url": { "path": [ "forms", ":qrId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Set to `1` to count this request as a scan when the form exists and rules allow. (This can only be one of 0,1)", "type": "text/plain" }, "key": "scan", "value": "1" } ], "variable": [ { "type": "any", "value": "TRYAWW447IK", "key": "qrId", "disabled": false, "description": { "content": "(Required) Public form identifier (uppercase letters and digits)", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4343b872-2279-43bc-8365-d6a97e39605c", "name": "Form detail", "originalRequest": { "url": { "path": [ "forms", ":qrId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Set to `1` to count this request as a scan when the form exists and rules allow. (This can only be one of 0,1)", "type": "text/plain" }, "key": "scan", "value": "1" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Public form identifier (uppercase letters and digits)", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"id\": \"\",\n \"qrId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"shortText\": \"\",\n \"shortUrl\": \"\",\n \"previewImage\": \"\",\n \"qrImage\": \"\",\n \"svgQrImage\": \"\",\n \"scans\": \"\",\n \"submissions\": \"\",\n \"active\": \"\",\n \"fields\": [\n {\n \"key\": \"\",\n \"type\": \"\",\n \"option\": {\n \"key_0\": \"string\"\n },\n \"quizConfig\": {\n \"key_0\": false\n }\n },\n {\n \"key\": \"\",\n \"type\": \"\",\n \"option\": {\n \"key_0\": true,\n \"key_1\": 490.8926043062012,\n \"key_2\": 4520,\n \"key_3\": 1971.2316974008504\n },\n \"quizConfig\": {\n \"key_0\": \"string\"\n }\n }\n ],\n \"qrConfig\": {\n \"backgroundColor\": \"\",\n \"colorDark\": \"\",\n \"eye_inner\": \"eyeInner5\",\n \"eye_outer\": \"eyeOuter1\",\n \"logo\": \"\",\n \"qrCategory\": \"\",\n \"qrData\": \"pattern13\",\n \"size\": \"\",\n \"transparentBkg\": \"\",\n \"gradient\": \"\",\n \"grdType\": \"radial\",\n \"color01\": \"\",\n \"color02\": \"\",\n \"eye_color\": \"\",\n \"eye_color01\": \"\",\n \"eye_color02\": \"\",\n \"frame\": 12,\n \"frameText\": \"\",\n \"frameTextFont\": \"Verdana\",\n \"frameColor\": \"\",\n \"frameColor2\": \"\",\n \"frameColorType\": \"diagonal1\",\n \"frameGradientStartColor\": \"\",\n \"frameGradientEndColor\": \"\"\n },\n \"isQuiz\": \"\",\n \"quizConfig\": {\n \"passingScore\": 70,\n \"distributeMarksEvenly\": \"\",\n \"enableTimeLimit\": \"\",\n \"timeLimit\": 1800,\n \"shuffleQuestions\": \"\",\n \"showFinalScore\": \"\",\n \"showAnswersResults\": \"\",\n \"stepByStep\": \"\",\n \"passMessage\": \"\",\n \"failMessage\": \"\",\n \"timeUpMessage\": \"\"\n },\n \"submissionNotification\": true,\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "917870da-4faf-4bab-8f68-72f2ca0bd46a", "name": "Invalid `qrId` format, or form does not exist / owner blocked", "originalRequest": { "url": { "path": [ "forms", ":qrId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Set to `1` to count this request as a scan when the form exists and rules allow. (This can only be one of 0,1)", "type": "text/plain" }, "key": "scan", "value": "1" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Public form identifier (uppercase letters and digits)", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9c18d42c-462b-45ac-8a56-b0b556930e71", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "forms", ":qrId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Set to `1` to count this request as a scan when the form exists and rules allow. (This can only be one of 0,1)", "type": "text/plain" }, "key": "scan", "value": "1" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Public form identifier (uppercase letters and digits)", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "54a069ad-380d-46fc-bbf6-e2bf5f69de0a", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "forms", ":qrId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Set to `1` to count this request as a scan when the form exists and rules allow. (This can only be one of 0,1)", "type": "text/plain" }, "key": "scan", "value": "1" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Public form identifier (uppercase letters and digits)", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cb36d159-6679-4af1-97a2-5a2949918832", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "forms", ":qrId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Set to `1` to count this request as a scan when the form exists and rules allow. (This can only be one of 0,1)", "type": "text/plain" }, "key": "scan", "value": "1" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Public form identifier (uppercase letters and digits)", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "228e210c-a8dd-4240-a4b8-f9f0698500b3", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "forms", ":qrId" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Set to `1` to count this request as a scan when the form exists and rules allow. (This can only be one of 0,1)", "type": "text/plain" }, "key": "scan", "value": "1" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Public form identifier (uppercase letters and digits)", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d3eeb6e3-f480-46f4-a836-2f10d0c85b3d", "name": "Update form", "request": { "name": "Update form", "description": { "content": "Update an existing form (partial body, same shape as create). **Prefer this over POST with qrId.** Viewer → **400**. Guide: [Manage Forms](https://docs.form-qr-code-generator.com/v1/index.htm#manage-forms).", "type": "text/plain" }, "url": { "path": [ "forms", ":qrId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "TRYAWW447IK", "key": "qrId", "disabled": false, "description": { "content": "(Required) Form identifier", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"shortText\": \"\",\n \"fields\": [\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n },\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n }\n ],\n \"backgroundType\": \"solid\",\n \"backgroundColor1\": \"0076d7\",\n \"backgroundColor2\": \"3a74c5\",\n \"appearance\": {\n \"headerColor\": \"ffffff\",\n \"buttonColor\": \"ffffff\"\n },\n \"logo\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backgroundImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backdrop\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"previewImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"qrConfig\": {\n \"backgroundColor\": \"\",\n \"colorDark\": \"\",\n \"eye_inner\": \"eyeInner8\",\n \"eye_outer\": \"eyeOuter7\",\n \"logo\": \"\",\n \"qrData\": \"pattern5\",\n \"size\": \"\",\n \"transparentBkg\": \"\",\n \"gradient\": \"\",\n \"grdType\": \"radial\",\n \"color01\": \"\",\n \"color02\": \"\",\n \"eye_color\": \"\",\n \"eye_color01\": \"\",\n \"eye_color02\": \"\",\n \"frame\": 4,\n \"frameText\": \"\",\n \"frameTextFont\": \"Times New Roman\",\n \"frameColor\": \"\",\n \"frameColor2\": \"\",\n \"frameColorType\": \"upDown\",\n \"frameGradientStartColor\": \"\",\n \"frameGradientEndColor\": \"\"\n },\n \"isQuiz\": false,\n \"quizConfig\": {\n \"passingScore\": 70,\n \"distributeMarksEvenly\": \"\",\n \"enableTimeLimit\": \"\",\n \"timeLimit\": 1800,\n \"shuffleQuestions\": \"\",\n \"showFinalScore\": \"\",\n \"showAnswersResults\": \"\",\n \"stepByStep\": \"\",\n \"passMessage\": \"\",\n \"failMessage\": \"\",\n \"timeUpMessage\": \"\"\n },\n \"submissionNotification\": true,\n \"locale\": \"\",\n \"shortUrl\": \"\",\n \"owner\": \"\",\n \"qrId\": \"\",\n \"qrImage\": \"\",\n \"scans\": \"\",\n \"submissions\": \"\",\n \"active\": \"\",\n \"expiryDate\": \"\",\n \"expiryScans\": \"\",\n \"expireByIP\": \"\",\n \"blocked\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "f458a955-1f4c-4282-90f1-e7f30e1b0dcd", "name": "Updated form", "originalRequest": { "url": { "path": [ "forms", ":qrId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"shortText\": \"\",\n \"fields\": [\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n },\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n }\n ],\n \"backgroundType\": \"solid\",\n \"backgroundColor1\": \"0076d7\",\n \"backgroundColor2\": \"3a74c5\",\n \"appearance\": {\n \"headerColor\": \"ffffff\",\n \"buttonColor\": \"ffffff\"\n },\n \"logo\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backgroundImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backdrop\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"previewImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"qrConfig\": {\n \"backgroundColor\": \"\",\n \"colorDark\": \"\",\n \"eye_inner\": \"eyeInner8\",\n \"eye_outer\": \"eyeOuter7\",\n \"logo\": \"\",\n \"qrData\": \"pattern5\",\n \"size\": \"\",\n \"transparentBkg\": \"\",\n \"gradient\": \"\",\n \"grdType\": \"radial\",\n \"color01\": \"\",\n \"color02\": \"\",\n \"eye_color\": \"\",\n \"eye_color01\": \"\",\n \"eye_color02\": \"\",\n \"frame\": 4,\n \"frameText\": \"\",\n \"frameTextFont\": \"Times New Roman\",\n \"frameColor\": \"\",\n \"frameColor2\": \"\",\n \"frameColorType\": \"upDown\",\n \"frameGradientStartColor\": \"\",\n \"frameGradientEndColor\": \"\"\n },\n \"isQuiz\": false,\n \"quizConfig\": {\n \"passingScore\": 70,\n \"distributeMarksEvenly\": \"\",\n \"enableTimeLimit\": \"\",\n \"timeLimit\": 1800,\n \"shuffleQuestions\": \"\",\n \"showFinalScore\": \"\",\n \"showAnswersResults\": \"\",\n \"stepByStep\": \"\",\n \"passMessage\": \"\",\n \"failMessage\": \"\",\n \"timeUpMessage\": \"\"\n },\n \"submissionNotification\": true,\n \"locale\": \"\",\n \"shortUrl\": \"\",\n \"owner\": \"\",\n \"qrId\": \"\",\n \"qrImage\": \"\",\n \"scans\": \"\",\n \"submissions\": \"\",\n \"active\": \"\",\n \"expiryDate\": \"\",\n \"expiryScans\": \"\",\n \"expireByIP\": \"\",\n \"blocked\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"id\": \"\",\n \"qrId\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"shortText\": \"\",\n \"shortUrl\": \"\",\n \"previewImage\": \"\",\n \"qrImage\": \"\",\n \"svgQrImage\": \"\",\n \"scans\": \"\",\n \"submissions\": \"\",\n \"active\": \"\",\n \"fields\": [\n {\n \"key\": \"\",\n \"type\": \"\",\n \"option\": {\n \"key_0\": \"string\"\n },\n \"quizConfig\": {\n \"key_0\": false\n }\n },\n {\n \"key\": \"\",\n \"type\": \"\",\n \"option\": {\n \"key_0\": true,\n \"key_1\": 490.8926043062012,\n \"key_2\": 4520,\n \"key_3\": 1971.2316974008504\n },\n \"quizConfig\": {\n \"key_0\": \"string\"\n }\n }\n ],\n \"qrConfig\": {\n \"backgroundColor\": \"\",\n \"colorDark\": \"\",\n \"eye_inner\": \"eyeInner5\",\n \"eye_outer\": \"eyeOuter1\",\n \"logo\": \"\",\n \"qrCategory\": \"\",\n \"qrData\": \"pattern13\",\n \"size\": \"\",\n \"transparentBkg\": \"\",\n \"gradient\": \"\",\n \"grdType\": \"radial\",\n \"color01\": \"\",\n \"color02\": \"\",\n \"eye_color\": \"\",\n \"eye_color01\": \"\",\n \"eye_color02\": \"\",\n \"frame\": 12,\n \"frameText\": \"\",\n \"frameTextFont\": \"Verdana\",\n \"frameColor\": \"\",\n \"frameColor2\": \"\",\n \"frameColorType\": \"diagonal1\",\n \"frameGradientStartColor\": \"\",\n \"frameGradientEndColor\": \"\"\n },\n \"isQuiz\": \"\",\n \"quizConfig\": {\n \"passingScore\": 70,\n \"distributeMarksEvenly\": \"\",\n \"enableTimeLimit\": \"\",\n \"timeLimit\": 1800,\n \"shuffleQuestions\": \"\",\n \"showFinalScore\": \"\",\n \"showAnswersResults\": \"\",\n \"stepByStep\": \"\",\n \"passMessage\": \"\",\n \"failMessage\": \"\",\n \"timeUpMessage\": \"\"\n },\n \"submissionNotification\": true,\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15dd6e81-21d8-433f-9bb1-cca4f76179ce", "name": "Validation error, not found, not allowed (e.g. Viewer), or GPS config error", "originalRequest": { "url": { "path": [ "forms", ":qrId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"shortText\": \"\",\n \"fields\": [\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n },\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n }\n ],\n \"backgroundType\": \"solid\",\n \"backgroundColor1\": \"0076d7\",\n \"backgroundColor2\": \"3a74c5\",\n \"appearance\": {\n \"headerColor\": \"ffffff\",\n \"buttonColor\": \"ffffff\"\n },\n \"logo\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backgroundImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backdrop\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"previewImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"qrConfig\": {\n \"backgroundColor\": \"\",\n \"colorDark\": \"\",\n \"eye_inner\": \"eyeInner8\",\n \"eye_outer\": \"eyeOuter7\",\n \"logo\": \"\",\n \"qrData\": \"pattern5\",\n \"size\": \"\",\n \"transparentBkg\": \"\",\n \"gradient\": \"\",\n \"grdType\": \"radial\",\n \"color01\": \"\",\n \"color02\": \"\",\n \"eye_color\": \"\",\n \"eye_color01\": \"\",\n \"eye_color02\": \"\",\n \"frame\": 4,\n \"frameText\": \"\",\n \"frameTextFont\": \"Times New Roman\",\n \"frameColor\": \"\",\n \"frameColor2\": \"\",\n \"frameColorType\": \"upDown\",\n \"frameGradientStartColor\": \"\",\n \"frameGradientEndColor\": \"\"\n },\n \"isQuiz\": false,\n \"quizConfig\": {\n \"passingScore\": 70,\n \"distributeMarksEvenly\": \"\",\n \"enableTimeLimit\": \"\",\n \"timeLimit\": 1800,\n \"shuffleQuestions\": \"\",\n \"showFinalScore\": \"\",\n \"showAnswersResults\": \"\",\n \"stepByStep\": \"\",\n \"passMessage\": \"\",\n \"failMessage\": \"\",\n \"timeUpMessage\": \"\"\n },\n \"submissionNotification\": true,\n \"locale\": \"\",\n \"shortUrl\": \"\",\n \"owner\": \"\",\n \"qrId\": \"\",\n \"qrImage\": \"\",\n \"scans\": \"\",\n \"submissions\": \"\",\n \"active\": \"\",\n \"expiryDate\": \"\",\n \"expiryScans\": \"\",\n \"expireByIP\": \"\",\n \"blocked\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc1fa847-350d-4f42-917e-10531e8e5896", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "forms", ":qrId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"shortText\": \"\",\n \"fields\": [\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n },\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n }\n ],\n \"backgroundType\": \"solid\",\n \"backgroundColor1\": \"0076d7\",\n \"backgroundColor2\": \"3a74c5\",\n \"appearance\": {\n \"headerColor\": \"ffffff\",\n \"buttonColor\": \"ffffff\"\n },\n \"logo\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backgroundImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backdrop\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"previewImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"qrConfig\": {\n \"backgroundColor\": \"\",\n \"colorDark\": \"\",\n \"eye_inner\": \"eyeInner8\",\n \"eye_outer\": \"eyeOuter7\",\n \"logo\": \"\",\n \"qrData\": \"pattern5\",\n \"size\": \"\",\n \"transparentBkg\": \"\",\n \"gradient\": \"\",\n \"grdType\": \"radial\",\n \"color01\": \"\",\n \"color02\": \"\",\n \"eye_color\": \"\",\n \"eye_color01\": \"\",\n \"eye_color02\": \"\",\n \"frame\": 4,\n \"frameText\": \"\",\n \"frameTextFont\": \"Times New Roman\",\n \"frameColor\": \"\",\n \"frameColor2\": \"\",\n \"frameColorType\": \"upDown\",\n \"frameGradientStartColor\": \"\",\n \"frameGradientEndColor\": \"\"\n },\n \"isQuiz\": false,\n \"quizConfig\": {\n \"passingScore\": 70,\n \"distributeMarksEvenly\": \"\",\n \"enableTimeLimit\": \"\",\n \"timeLimit\": 1800,\n \"shuffleQuestions\": \"\",\n \"showFinalScore\": \"\",\n \"showAnswersResults\": \"\",\n \"stepByStep\": \"\",\n \"passMessage\": \"\",\n \"failMessage\": \"\",\n \"timeUpMessage\": \"\"\n },\n \"submissionNotification\": true,\n \"locale\": \"\",\n \"shortUrl\": \"\",\n \"owner\": \"\",\n \"qrId\": \"\",\n \"qrImage\": \"\",\n \"scans\": \"\",\n \"submissions\": \"\",\n \"active\": \"\",\n \"expiryDate\": \"\",\n \"expiryScans\": \"\",\n \"expireByIP\": \"\",\n \"blocked\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a147988b-8d02-4433-bfab-c1141020aeb0", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "forms", ":qrId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"shortText\": \"\",\n \"fields\": [\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n },\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n }\n ],\n \"backgroundType\": \"solid\",\n \"backgroundColor1\": \"0076d7\",\n \"backgroundColor2\": \"3a74c5\",\n \"appearance\": {\n \"headerColor\": \"ffffff\",\n \"buttonColor\": \"ffffff\"\n },\n \"logo\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backgroundImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backdrop\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"previewImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"qrConfig\": {\n \"backgroundColor\": \"\",\n \"colorDark\": \"\",\n \"eye_inner\": \"eyeInner8\",\n \"eye_outer\": \"eyeOuter7\",\n \"logo\": \"\",\n \"qrData\": \"pattern5\",\n \"size\": \"\",\n \"transparentBkg\": \"\",\n \"gradient\": \"\",\n \"grdType\": \"radial\",\n \"color01\": \"\",\n \"color02\": \"\",\n \"eye_color\": \"\",\n \"eye_color01\": \"\",\n \"eye_color02\": \"\",\n \"frame\": 4,\n \"frameText\": \"\",\n \"frameTextFont\": \"Times New Roman\",\n \"frameColor\": \"\",\n \"frameColor2\": \"\",\n \"frameColorType\": \"upDown\",\n \"frameGradientStartColor\": \"\",\n \"frameGradientEndColor\": \"\"\n },\n \"isQuiz\": false,\n \"quizConfig\": {\n \"passingScore\": 70,\n \"distributeMarksEvenly\": \"\",\n \"enableTimeLimit\": \"\",\n \"timeLimit\": 1800,\n \"shuffleQuestions\": \"\",\n \"showFinalScore\": \"\",\n \"showAnswersResults\": \"\",\n \"stepByStep\": \"\",\n \"passMessage\": \"\",\n \"failMessage\": \"\",\n \"timeUpMessage\": \"\"\n },\n \"submissionNotification\": true,\n \"locale\": \"\",\n \"shortUrl\": \"\",\n \"owner\": \"\",\n \"qrId\": \"\",\n \"qrImage\": \"\",\n \"scans\": \"\",\n \"submissions\": \"\",\n \"active\": \"\",\n \"expiryDate\": \"\",\n \"expiryScans\": \"\",\n \"expireByIP\": \"\",\n \"blocked\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "beb471ba-5019-4722-8bd7-fcd48d17ca6b", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "forms", ":qrId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"shortText\": \"\",\n \"fields\": [\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n },\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n }\n ],\n \"backgroundType\": \"solid\",\n \"backgroundColor1\": \"0076d7\",\n \"backgroundColor2\": \"3a74c5\",\n \"appearance\": {\n \"headerColor\": \"ffffff\",\n \"buttonColor\": \"ffffff\"\n },\n \"logo\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backgroundImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backdrop\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"previewImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"qrConfig\": {\n \"backgroundColor\": \"\",\n \"colorDark\": \"\",\n \"eye_inner\": \"eyeInner8\",\n \"eye_outer\": \"eyeOuter7\",\n \"logo\": \"\",\n \"qrData\": \"pattern5\",\n \"size\": \"\",\n \"transparentBkg\": \"\",\n \"gradient\": \"\",\n \"grdType\": \"radial\",\n \"color01\": \"\",\n \"color02\": \"\",\n \"eye_color\": \"\",\n \"eye_color01\": \"\",\n \"eye_color02\": \"\",\n \"frame\": 4,\n \"frameText\": \"\",\n \"frameTextFont\": \"Times New Roman\",\n \"frameColor\": \"\",\n \"frameColor2\": \"\",\n \"frameColorType\": \"upDown\",\n \"frameGradientStartColor\": \"\",\n \"frameGradientEndColor\": \"\"\n },\n \"isQuiz\": false,\n \"quizConfig\": {\n \"passingScore\": 70,\n \"distributeMarksEvenly\": \"\",\n \"enableTimeLimit\": \"\",\n \"timeLimit\": 1800,\n \"shuffleQuestions\": \"\",\n \"showFinalScore\": \"\",\n \"showAnswersResults\": \"\",\n \"stepByStep\": \"\",\n \"passMessage\": \"\",\n \"failMessage\": \"\",\n \"timeUpMessage\": \"\"\n },\n \"submissionNotification\": true,\n \"locale\": \"\",\n \"shortUrl\": \"\",\n \"owner\": \"\",\n \"qrId\": \"\",\n \"qrImage\": \"\",\n \"scans\": \"\",\n \"submissions\": \"\",\n \"active\": \"\",\n \"expiryDate\": \"\",\n \"expiryScans\": \"\",\n \"expireByIP\": \"\",\n \"blocked\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c352038-068c-4def-89bf-0f6d31686738", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "forms", ":qrId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"title\": \"\",\n \"shortText\": \"\",\n \"fields\": [\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n },\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n }\n ],\n \"backgroundType\": \"solid\",\n \"backgroundColor1\": \"0076d7\",\n \"backgroundColor2\": \"3a74c5\",\n \"appearance\": {\n \"headerColor\": \"ffffff\",\n \"buttonColor\": \"ffffff\"\n },\n \"logo\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backgroundImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backdrop\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"previewImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"qrConfig\": {\n \"backgroundColor\": \"\",\n \"colorDark\": \"\",\n \"eye_inner\": \"eyeInner8\",\n \"eye_outer\": \"eyeOuter7\",\n \"logo\": \"\",\n \"qrData\": \"pattern5\",\n \"size\": \"\",\n \"transparentBkg\": \"\",\n \"gradient\": \"\",\n \"grdType\": \"radial\",\n \"color01\": \"\",\n \"color02\": \"\",\n \"eye_color\": \"\",\n \"eye_color01\": \"\",\n \"eye_color02\": \"\",\n \"frame\": 4,\n \"frameText\": \"\",\n \"frameTextFont\": \"Times New Roman\",\n \"frameColor\": \"\",\n \"frameColor2\": \"\",\n \"frameColorType\": \"upDown\",\n \"frameGradientStartColor\": \"\",\n \"frameGradientEndColor\": \"\"\n },\n \"isQuiz\": false,\n \"quizConfig\": {\n \"passingScore\": 70,\n \"distributeMarksEvenly\": \"\",\n \"enableTimeLimit\": \"\",\n \"timeLimit\": 1800,\n \"shuffleQuestions\": \"\",\n \"showFinalScore\": \"\",\n \"showAnswersResults\": \"\",\n \"stepByStep\": \"\",\n \"passMessage\": \"\",\n \"failMessage\": \"\",\n \"timeUpMessage\": \"\"\n },\n \"submissionNotification\": true,\n \"locale\": \"\",\n \"shortUrl\": \"\",\n \"owner\": \"\",\n \"qrId\": \"\",\n \"qrImage\": \"\",\n \"scans\": \"\",\n \"submissions\": \"\",\n \"active\": \"\",\n \"expiryDate\": \"\",\n \"expiryScans\": \"\",\n \"expireByIP\": \"\",\n \"blocked\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1c14ddca-3d37-4932-89e7-195a5334f20d", "name": "Delete form", "request": { "name": "Delete form", "description": { "content": "Delete one form (scan count and role rules apply). Viewer cannot delete.", "type": "text/plain" }, "url": { "path": [ "forms", ":qrId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "TRYAWW447IK", "key": "qrId", "disabled": false, "description": { "content": "(Required) Form identifier", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b46b2aa7-a45d-4118-9e69-b9990c11528c", "name": "Form deleted", "originalRequest": { "url": { "path": [ "forms", ":qrId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"result\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "81f74603-d0eb-4f8e-9ed5-969ca8b5469c", "name": "Not allowed (e.g. Viewer) or business rule failure", "originalRequest": { "url": { "path": [ "forms", ":qrId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d77d43b-fb97-4af5-a0e9-a6a91b47b96a", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "forms", ":qrId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dde6e704-ef45-483e-908a-2e59b0a11a99", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "forms", ":qrId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e54c2b0c-4e4b-4609-894e-33474fb343e7", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "forms", ":qrId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5540f3b8-9ead-4a8b-a8fb-adafebacfe74", "name": "Unhandled error (e.g. constraint failed after series step)", "originalRequest": { "url": { "path": [ "forms", ":qrId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "uploads", "description": "", "item": [ { "id": "42f3ea8f-0d91-44d3-a07a-95d1082219eb", "name": "Upload file for a form or submission", "request": { "name": "Upload file for a form or submission", "description": { "content": "Upload form asset or submission file (`category=form` or `submission`). Multipart `userFile`, max 20 MB. Unknown form → **404**. Guide: [Upload APIs Compared](https://docs.form-qr-code-generator.com/v1/index.htm#upload-apis-compared).", "type": "text/plain" }, "url": { "path": [ "forms", ":qrId", "uploads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Use `submission` for submission attachments, `form` for assets belonging to the form itself. (This can only be one of form,submission)", "type": "text/plain" }, "key": "cat", "value": "submission" } ], "variable": [ { "type": "any", "value": "TRYAWW447IK", "key": "qrId", "disabled": false, "description": { "content": "(Required) Target form id", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The File to Upload", "type": "text/plain" }, "key": "userFile", "type": "file" }, { "description": { "content": "(Required) Category of the file", "type": "text/plain" }, "key": "category", "value": "submission", "type": "text" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d6fc7dbd-ccb5-4edc-a3ea-56457b12f932", "name": "Upload succeeded", "originalRequest": { "url": { "path": [ "forms", ":qrId", "uploads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Use `submission` for submission attachments, `form` for assets belonging to the form itself. (This can only be one of form,submission)", "type": "text/plain" }, "key": "cat", "value": "submission" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Target form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The File to Upload", "type": "text/plain" }, "key": "userFile", "type": "file" }, { "description": { "content": "(Required) Category of the file", "type": "text/plain" }, "key": "category", "value": "submission", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"fileUrl\": \"\",\n \"fileId\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "408f03dd-83a8-4c05-96be-6386391a82b6", "name": "Missing file or unsupported file type for the category", "originalRequest": { "url": { "path": [ "forms", ":qrId", "uploads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Use `submission` for submission attachments, `form` for assets belonging to the form itself. (This can only be one of form,submission)", "type": "text/plain" }, "key": "cat", "value": "submission" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Target form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The File to Upload", "type": "text/plain" }, "key": "userFile", "type": "file" }, { "description": { "content": "(Required) Category of the file", "type": "text/plain" }, "key": "category", "value": "submission", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b6bca50-b7d1-40b4-be6d-598cc036a689", "name": "Missing or invalid API key (same Bearer API-key auth as other public routes)", "originalRequest": { "url": { "path": [ "forms", ":qrId", "uploads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Use `submission` for submission attachments, `form` for assets belonging to the form itself. (This can only be one of form,submission)", "type": "text/plain" }, "key": "cat", "value": "submission" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Target form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The File to Upload", "type": "text/plain" }, "key": "userFile", "type": "file" }, { "description": { "content": "(Required) Category of the file", "type": "text/plain" }, "key": "category", "value": "submission", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d925c33c-8b8c-447d-ba3f-a0722100ded6", "name": "Form not found for this API key, archived, or owner blocked (integration handler). A malformed `qrId` (not matching `^[A-Z0-9]+$`) may also return **404** on POST — unlike DELETE, which returns **400** for invalid format before lookup.", "originalRequest": { "url": { "path": [ "forms", ":qrId", "uploads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Use `submission` for submission attachments, `form` for assets belonging to the form itself. (This can only be one of form,submission)", "type": "text/plain" }, "key": "cat", "value": "submission" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Target form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The File to Upload", "type": "text/plain" }, "key": "userFile", "type": "file" }, { "description": { "content": "(Required) Category of the file", "type": "text/plain" }, "key": "category", "value": "submission", "type": "text" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d8a1597b-e2f2-43fb-928d-8907001858e8", "name": "Rate limit exceeded for `category=submission` uploads (200 requests per 5 minutes per client IP and `qrId`).", "originalRequest": { "url": { "path": [ "forms", ":qrId", "uploads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Use `submission` for submission attachments, `form` for assets belonging to the form itself. (This can only be one of form,submission)", "type": "text/plain" }, "key": "cat", "value": "submission" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Target form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The File to Upload", "type": "text/plain" }, "key": "userFile", "type": "file" }, { "description": { "content": "(Required) Category of the file", "type": "text/plain" }, "key": "category", "value": "submission", "type": "text" } ] } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "30c5be6f-e285-4f84-9da6-5e3fd143d209", "name": "Server error while saving the file, or file exceeds 20 MB (`message`: `uploaded file is too large`)", "originalRequest": { "url": { "path": [ "forms", ":qrId", "uploads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Use `submission` for submission attachments, `form` for assets belonging to the form itself. (This can only be one of form,submission)", "type": "text/plain" }, "key": "cat", "value": "submission" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Target form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The File to Upload", "type": "text/plain" }, "key": "userFile", "type": "file" }, { "description": { "content": "(Required) Category of the file", "type": "text/plain" }, "key": "category", "value": "submission", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{fileId}", "description": "", "item": [ { "id": "d2563584-8f95-4e33-9138-9828cd9ed1f9", "name": "Delete an uploaded form or submission file", "request": { "name": "Delete an uploaded form or submission file", "description": { "content": "Delete a file uploaded with POST /forms/{qrId}/uploads. Invalid qrId format → **400**.", "type": "text/plain" }, "url": { "path": [ "forms", ":qrId", "uploads", ":fileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "TRYAWW447IK", "key": "qrId", "disabled": false, "description": { "content": "(Required) Target form id", "type": "text/plain" } }, { "type": "any", "value": "", "key": "fileId", "disabled": false, "description": { "content": "(Required) File id from upload response `data.fileId`", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "397dd3a3-5a1a-4621-9ebc-d3e2366cebb4", "name": "File deleted (or already absent; idempotent success)", "originalRequest": { "url": { "path": [ "forms", ":qrId", "uploads", ":fileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Target form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" }, { "disabled": false, "description": { "content": "(Required) File id from upload response `data.fileId`", "type": "text/plain" }, "type": "any", "value": "", "key": "fileId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59cd5b1d-c353-462a-97b2-0df30640bb05", "name": "Invalid `qrId` format", "originalRequest": { "url": { "path": [ "forms", ":qrId", "uploads", ":fileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Target form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" }, { "disabled": false, "description": { "content": "(Required) File id from upload response `data.fileId`", "type": "text/plain" }, "type": "any", "value": "", "key": "fileId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b06dd9bf-d426-495c-8c95-27d979869f98", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "forms", ":qrId", "uploads", ":fileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Target form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" }, { "disabled": false, "description": { "content": "(Required) File id from upload response `data.fileId`", "type": "text/plain" }, "type": "any", "value": "", "key": "fileId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "236156a8-c560-4ec4-b636-2f7fcd94476f", "name": "Form not found for this API key, or file not found for this form", "originalRequest": { "url": { "path": [ "forms", ":qrId", "uploads", ":fileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Target form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" }, { "disabled": false, "description": { "content": "(Required) File id from upload response `data.fileId`", "type": "text/plain" }, "type": "any", "value": "", "key": "fileId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "790bfdb2-69a8-426c-a8aa-8763b4238198", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "forms", ":qrId", "uploads", ":fileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Target form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" }, { "disabled": false, "description": { "content": "(Required) File id from upload response `data.fileId`", "type": "text/plain" }, "type": "any", "value": "", "key": "fileId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00069f48-b75a-4181-8dcc-f00d367a2758", "name": "Unexpected error while deleting the file", "originalRequest": { "url": { "path": [ "forms", ":qrId", "uploads", ":fileId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Target form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" }, { "disabled": false, "description": { "content": "(Required) File id from upload response `data.fileId`", "type": "text/plain" }, "type": "any", "value": "", "key": "fileId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "archive", "description": "", "item": [ { "id": "6c2d6f35-a6fc-4a1e-9624-083597298ff2", "name": "Archive form", "request": { "name": "Archive form", "description": { "content": "Archive a form (hidden from default list).", "type": "text/plain" }, "url": { "path": [ "forms", ":qrId", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "TRYAWW447IK", "key": "qrId", "disabled": false, "description": { "content": "(Required) Form identifier (`qrId`, e.g. `ABC123`).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "dea7ad2c-a540-4aaf-9e02-5ee2a6971730", "name": "Archived (or idempotent message if already archived)", "originalRequest": { "url": { "path": [ "forms", ":qrId", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier (`qrId`, e.g. `ABC123`).", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"result\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5efa323c-5f13-409e-ba7e-4cd032361f7d", "name": "Not found, not allowed, or processing error", "originalRequest": { "url": { "path": [ "forms", ":qrId", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier (`qrId`, e.g. `ABC123`).", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a6dcb70-6859-4bb9-85b2-dc97067533a7", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "forms", ":qrId", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier (`qrId`, e.g. `ABC123`).", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63d07a2c-1d1f-4557-a3c9-3b4548674ac6", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "forms", ":qrId", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier (`qrId`, e.g. `ABC123`).", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1dcbf943-d5fa-4ae3-8d63-84090e744823", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "forms", ":qrId", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier (`qrId`, e.g. `ABC123`).", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d1be99f-6c7a-4624-ba08-7c889a3e58f4", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "forms", ":qrId", "archive" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier (`qrId`, e.g. `ABC123`).", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "restore", "description": "", "item": [ { "id": "0d8ddf7f-e2b6-4ee3-9006-f1b9faa1a4c9", "name": "Restore archived form", "request": { "name": "Restore archived form", "description": { "content": "Restore an archived form.", "type": "text/plain" }, "url": { "path": [ "forms", ":qrId", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "TRYAWW447IK", "key": "qrId", "disabled": false, "description": { "content": "(Required) Form identifier (`qrId`, e.g. `ABC123`).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9fc33470-16af-47e4-8afa-7b91a205d7e6", "name": "Restored or already active", "originalRequest": { "url": { "path": [ "forms", ":qrId", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier (`qrId`, e.g. `ABC123`).", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"result\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "91f750c1-593f-461c-8f98-019049c7ac43", "name": "Not found, not allowed, or save error", "originalRequest": { "url": { "path": [ "forms", ":qrId", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier (`qrId`, e.g. `ABC123`).", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9db5454f-e069-49bf-b53d-42a61343e703", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "forms", ":qrId", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier (`qrId`, e.g. `ABC123`).", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af5c23fd-18cf-4650-9cef-6fc2b3a7e9ae", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "forms", ":qrId", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier (`qrId`, e.g. `ABC123`).", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc7a1eed-55b2-4422-b0bd-e11e4f423648", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "forms", ":qrId", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier (`qrId`, e.g. `ABC123`).", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3264d433-4c2d-4865-8cd8-8697850b58e5", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "forms", ":qrId", "restore" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier (`qrId`, e.g. `ABC123`).", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "download", "description": "", "item": [ { "id": "432a57e0-f1b6-4fda-90c9-5b79c837bbd6", "name": "Download form QR image (custom format)", "request": { "name": "Download form QR image (custom format)", "description": { "content": "Download QR image (binary response, not JSON). Requires `format` query param. Guide: [End-to-End Integration](https://docs.form-qr-code-generator.com/v1/index.htm#end-to-end-integration) Step 5.", "type": "text/plain" }, "url": { "path": [ "forms", ":qrId", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Output format: `png`, `svg`, `pdf`, or `eps`. (This can only be one of png,svg,pdf,eps)", "type": "text/plain" }, "key": "format", "value": "pdf" }, { "disabled": false, "description": { "content": "(Required) Pixel size when rasterizing from SVG (used for png, pdf, eps, and svg viewBox sizing)", "type": "text/plain" }, "key": "resolution", "value": "" } ], "variable": [ { "type": "any", "value": "TRYAWW447IK", "key": "qrId", "disabled": false, "description": { "content": "(Required) Form id (`qrId`)", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "382d40e2-4cba-4ab8-ba54-a09cb8b21fbc", "name": "Binary file body. `Content-Type` matches the requested `format` (e.g. `image/png` for `format=png`).", "originalRequest": { "url": { "path": [ "forms", ":qrId", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Output format: `png`, `svg`, `pdf`, or `eps`. (This can only be one of png,svg,pdf,eps)", "type": "text/plain" }, "key": "format", "value": "pdf" }, { "disabled": false, "description": { "content": "(Required) Pixel size when rasterizing from SVG (used for png, pdf, eps, and svg viewBox sizing)", "type": "text/plain" }, "key": "resolution", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id (`qrId`)", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/octet-stream" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/octet-stream" }, { "disabled": false, "description": { "content": "MIME type for the requested format", "type": "text/plain" }, "key": "Content-Type", "value": "" }, { "disabled": false, "description": { "content": "Attachment filename", "type": "text/plain" }, "key": "Content-Disposition", "value": "" }, { "disabled": false, "description": { "content": "Size of the binary body in bytes", "type": "text/plain" }, "key": "Content-Length", "value": "" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "64643e8e-7e00-4fe9-bafe-a1091b902f80", "name": "Missing parameters or client error", "originalRequest": { "url": { "path": [ "forms", ":qrId", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Output format: `png`, `svg`, `pdf`, or `eps`. (This can only be one of png,svg,pdf,eps)", "type": "text/plain" }, "key": "format", "value": "pdf" }, { "disabled": false, "description": { "content": "(Required) Pixel size when rasterizing from SVG (used for png, pdf, eps, and svg viewBox sizing)", "type": "text/plain" }, "key": "resolution", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id (`qrId`)", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8947ae59-16b2-4323-a7f2-6c22628c5d95", "name": "Not authorized", "originalRequest": { "url": { "path": [ "forms", ":qrId", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Output format: `png`, `svg`, `pdf`, or `eps`. (This can only be one of png,svg,pdf,eps)", "type": "text/plain" }, "key": "format", "value": "pdf" }, { "disabled": false, "description": { "content": "(Required) Pixel size when rasterizing from SVG (used for png, pdf, eps, and svg viewBox sizing)", "type": "text/plain" }, "key": "resolution", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id (`qrId`)", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "42d9b4c8-2d72-4154-8316-80f7980506eb", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "forms", ":qrId", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Output format: `png`, `svg`, `pdf`, or `eps`. (This can only be one of png,svg,pdf,eps)", "type": "text/plain" }, "key": "format", "value": "pdf" }, { "disabled": false, "description": { "content": "(Required) Pixel size when rasterizing from SVG (used for png, pdf, eps, and svg viewBox sizing)", "type": "text/plain" }, "key": "resolution", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id (`qrId`)", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ee5dce6-9c01-4219-a69b-70c3862d50bc", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "forms", ":qrId", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Output format: `png`, `svg`, `pdf`, or `eps`. (This can only be one of png,svg,pdf,eps)", "type": "text/plain" }, "key": "format", "value": "pdf" }, { "disabled": false, "description": { "content": "(Required) Pixel size when rasterizing from SVG (used for png, pdf, eps, and svg viewBox sizing)", "type": "text/plain" }, "key": "resolution", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id (`qrId`)", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "048badc1-6798-468a-a001-5e640b32263b", "name": "Form not found or render failure", "originalRequest": { "url": { "path": [ "forms", ":qrId", "download" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Output format: `png`, `svg`, `pdf`, or `eps`. (This can only be one of png,svg,pdf,eps)", "type": "text/plain" }, "key": "format", "value": "pdf" }, { "disabled": false, "description": { "content": "(Required) Pixel size when rasterizing from SVG (used for png, pdf, eps, and svg viewBox sizing)", "type": "text/plain" }, "key": "resolution", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id (`qrId`)", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "clone", "description": "", "item": [ { "id": "056419be-f6d9-4eb5-97be-fe3261fb913c", "name": "Clone form(s)", "request": { "name": "Clone form(s)", "description": { "content": "Create one or more copies of a form.", "type": "text/plain" }, "url": { "path": [ "forms", ":qrId", "clone" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "How many clones to create", "type": "text/plain" }, "key": "numberofCopies", "value": "1" } ], "variable": [ { "type": "any", "value": "TRYAWW447IK", "key": "qrId", "disabled": false, "description": { "content": "(Required) Form identifier (`qrId`, e.g. `ABC123`).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6788c881-3ef3-4e4b-a6d0-c1754d00c0e2", "name": "Clones created", "originalRequest": { "url": { "path": [ "forms", ":qrId", "clone" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "How many clones to create", "type": "text/plain" }, "key": "numberofCopies", "value": "1" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier (`qrId`, e.g. `ABC123`).", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"cloneData\": [\n {\n \"data\": {\n \"key_0\": 3769.976546790914,\n \"key_1\": \"string\"\n },\n \"qrImgUrl\": \"\",\n \"image\": \"\"\n },\n {\n \"data\": {\n \"key_0\": 9207\n },\n \"qrImgUrl\": \"\",\n \"image\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e11092d-7834-4c7f-938b-02bef108fbcc", "name": "Quota, permission, or pipeline error", "originalRequest": { "url": { "path": [ "forms", ":qrId", "clone" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "How many clones to create", "type": "text/plain" }, "key": "numberofCopies", "value": "1" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier (`qrId`, e.g. `ABC123`).", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14418d68-5c7f-4080-99f1-2d3abebdd6de", "name": "Not authorized", "originalRequest": { "url": { "path": [ "forms", ":qrId", "clone" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "How many clones to create", "type": "text/plain" }, "key": "numberofCopies", "value": "1" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier (`qrId`, e.g. `ABC123`).", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67024d45-1d4d-4fb4-8f22-00cd229e8bae", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "forms", ":qrId", "clone" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "How many clones to create", "type": "text/plain" }, "key": "numberofCopies", "value": "1" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier (`qrId`, e.g. `ABC123`).", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6a3e3b8b-aedf-46af-8fbb-9074ba0cfc25", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "forms", ":qrId", "clone" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "How many clones to create", "type": "text/plain" }, "key": "numberofCopies", "value": "1" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier (`qrId`, e.g. `ABC123`).", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c903d2ff-b917-4ce0-b3db-1b875a131aa5", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "forms", ":qrId", "clone" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "How many clones to create", "type": "text/plain" }, "key": "numberofCopies", "value": "1" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier (`qrId`, e.g. `ABC123`).", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "share", "description": "", "item": [ { "id": "8555eb80-04f2-4c6d-bc28-5a72b9b446ca", "name": "Share form by email", "request": { "name": "Share form by email", "description": { "content": "Email form link to recipients (comma-separated string, max 5).", "type": "text/plain" }, "url": { "path": [ "forms", ":qrId", "share" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "TRYAWW447IK", "key": "qrId", "disabled": false, "description": { "content": "(Required) Form identifier (`qrId`, e.g. `ABC123`).", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"recipients\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "40ade226-f974-4bd8-9860-a673d526933a", "name": "Sent", "originalRequest": { "url": { "path": [ "forms", ":qrId", "share" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier (`qrId`, e.g. `ABC123`).", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"recipients\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "470868b0-3b5a-4322-afd3-7e49da0c8e2b", "name": "Invalid recipients, not found, or mail error", "originalRequest": { "url": { "path": [ "forms", ":qrId", "share" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier (`qrId`, e.g. `ABC123`).", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"recipients\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f7fef30-5284-4722-947f-1696c066d858", "name": "Not authorized", "originalRequest": { "url": { "path": [ "forms", ":qrId", "share" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier (`qrId`, e.g. `ABC123`).", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"recipients\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e973aec1-5e6c-47fc-8d1f-925185c3f285", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "forms", ":qrId", "share" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier (`qrId`, e.g. `ABC123`).", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"recipients\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1218c81-bd69-4554-b77d-76cb7bc74323", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "forms", ":qrId", "share" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier (`qrId`, e.g. `ABC123`).", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"recipients\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de788a6f-8334-461b-87b6-47bc642049bc", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "forms", ":qrId", "share" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form identifier (`qrId`, e.g. `ABC123`).", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"recipients\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "submissions", "description": "", "item": [ { "id": "82eaf774-a8e9-4529-9fe2-08a60b3d524f", "name": "List submissions for a form", "request": { "name": "List submissions for a form", "description": { "content": "Paginated submissions for a form. Optional `since` / `until`. Empty list → **200** with `items: []`. Guide: [Read Submissions](https://docs.form-qr-code-generator.com/v1/index.htm#read-submissions).", "type": "text/plain" }, "url": { "path": [ "forms", ":qrId", "submissions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page index (1-based). Default: 1.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Page size (submissions per page). Default: 50. Maximum: 100.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Include submissions with `createdAt` on or after this time. ISO 8601 (e.g. `2025-01-01T00:00:00Z`) or Unix timestamp (seconds or milliseconds).", "type": "text/plain" }, "key": "since", "value": "" }, { "disabled": false, "description": { "content": "Include submissions with `createdAt` on or before this time. Same formats as `since`.", "type": "text/plain" }, "key": "until", "value": "" } ], "variable": [ { "type": "any", "value": "TRYAWW447IK", "key": "qrId", "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ef8b2bd0-d0e4-441d-ab72-fc466a1a07a2", "name": "List result", "originalRequest": { "url": { "path": [ "forms", ":qrId", "submissions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page index (1-based). Default: 1.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Page size (submissions per page). Default: 50. Maximum: 100.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Include submissions with `createdAt` on or after this time. ISO 8601 (e.g. `2025-01-01T00:00:00Z`) or Unix timestamp (seconds or milliseconds).", "type": "text/plain" }, "key": "since", "value": "" }, { "disabled": false, "description": { "content": "Include submissions with `createdAt` on or before this time. Same formats as `since`.", "type": "text/plain" }, "key": "until", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"items\": [\n {\n \"id\": \"\",\n \"qrId\": \"\",\n \"answers\": {\n \"key_0\": 2985.820410558724\n },\n \"quizData\": {\n \"key_0\": false\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"qrId\": \"\",\n \"answers\": {\n \"key_0\": 5328.84146329305,\n \"key_1\": true\n },\n \"quizData\": {\n \"key_0\": 6987\n },\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"total\": \"\",\n \"page\": \"\",\n \"pageSize\": \"\",\n \"totalPages\": \"\"\n },\n \"form\": {\n \"fields\": [\n {\n \"key\": \"\",\n \"type\": \"\",\n \"option\": {\n \"key_0\": 7257.603007910234\n },\n \"quizConfig\": {\n \"key_0\": 9125.186095260544\n }\n },\n {\n \"key\": \"\",\n \"type\": \"\",\n \"option\": {\n \"key_0\": 5906,\n \"key_1\": true\n },\n \"quizConfig\": {\n \"key_0\": true,\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n }\n }\n ],\n \"title\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3e00bf06-907c-4048-832c-024772de9139", "name": "Invalid `qrId` format, unknown form, wrong account, archived form, or blocked owner", "originalRequest": { "url": { "path": [ "forms", ":qrId", "submissions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page index (1-based). Default: 1.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Page size (submissions per page). Default: 50. Maximum: 100.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Include submissions with `createdAt` on or after this time. ISO 8601 (e.g. `2025-01-01T00:00:00Z`) or Unix timestamp (seconds or milliseconds).", "type": "text/plain" }, "key": "since", "value": "" }, { "disabled": false, "description": { "content": "Include submissions with `createdAt` on or before this time. Same formats as `since`.", "type": "text/plain" }, "key": "until", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17d8ce71-7787-4b8a-964a-6b3e684ca965", "name": "Missing or invalid `Authorization: Bearer` API key.", "originalRequest": { "url": { "path": [ "forms", ":qrId", "submissions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page index (1-based). Default: 1.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Page size (submissions per page). Default: 50. Maximum: 100.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Include submissions with `createdAt` on or after this time. ISO 8601 (e.g. `2025-01-01T00:00:00Z`) or Unix timestamp (seconds or milliseconds).", "type": "text/plain" }, "key": "since", "value": "" }, { "disabled": false, "description": { "content": "Include submissions with `createdAt` on or before this time. Same formats as `since`.", "type": "text/plain" }, "key": "until", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "33f29ae1-650f-42ef-b695-849aecbcd378", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "forms", ":qrId", "submissions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page index (1-based). Default: 1.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Page size (submissions per page). Default: 50. Maximum: 100.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Include submissions with `createdAt` on or after this time. ISO 8601 (e.g. `2025-01-01T00:00:00Z`) or Unix timestamp (seconds or milliseconds).", "type": "text/plain" }, "key": "since", "value": "" }, { "disabled": false, "description": { "content": "Include submissions with `createdAt` on or before this time. Same formats as `since`.", "type": "text/plain" }, "key": "until", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40cbd063-b412-48a8-8a08-97b18ff5e000", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "forms", ":qrId", "submissions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page index (1-based). Default: 1.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Page size (submissions per page). Default: 50. Maximum: 100.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Include submissions with `createdAt` on or after this time. ISO 8601 (e.g. `2025-01-01T00:00:00Z`) or Unix timestamp (seconds or milliseconds).", "type": "text/plain" }, "key": "since", "value": "" }, { "disabled": false, "description": { "content": "Include submissions with `createdAt` on or before this time. Same formats as `since`.", "type": "text/plain" }, "key": "until", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "950e8149-1224-4087-9c72-f09328a09d5d", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "forms", ":qrId", "submissions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Page index (1-based). Default: 1.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Page size (submissions per page). Default: 50. Maximum: 100.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Include submissions with `createdAt` on or after this time. ISO 8601 (e.g. `2025-01-01T00:00:00Z`) or Unix timestamp (seconds or milliseconds).", "type": "text/plain" }, "key": "since", "value": "" }, { "disabled": false, "description": { "content": "Include submissions with `createdAt` on or before this time. Same formats as `since`.", "type": "text/plain" }, "key": "until", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "521e53e0-50ef-4998-948a-8f1177f6c824", "name": "Create a submission", "request": { "name": "Create a submission", "description": { "content": "Create a response with `answers` map. Optional `Idempotency-Key` header. Call `submission-schema` first. Guide: [Create a Submission](https://docs.form-qr-code-generator.com/v1/index.htm#create-submission).", "type": "text/plain" }, "url": { "path": [ "forms", ":qrId", "submissions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "TRYAWW447IK", "key": "qrId", "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Optional. Same key + identical request body replays the original success response (24h TTL). Same key + different body returns HTTP **409**.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answers\": {\n \"key_0\": 7640.869751596915,\n \"key_1\": 658,\n \"key_2\": 9006.685442857051,\n \"key_3\": \"string\",\n \"key_4\": 8843\n },\n \"timeSpentSeconds\": \"\",\n \"timeExpired\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "09d048db-ab71-45ac-833b-6e5f7174993c", "name": "Created", "originalRequest": { "url": { "path": [ "forms", ":qrId", "submissions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional. Same key + identical request body replays the original success response (24h TTL). Same key + different body returns HTTP **409**.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answers\": {\n \"key_0\": 7640.869751596915,\n \"key_1\": 658,\n \"key_2\": 9006.685442857051,\n \"key_3\": \"string\",\n \"key_4\": 8843\n },\n \"timeSpentSeconds\": \"\",\n \"timeExpired\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"submissionId\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1b0308e-43be-41f6-9485-bdebc8bc86a4", "name": "Validation, plan limit, or form missing", "originalRequest": { "url": { "path": [ "forms", ":qrId", "submissions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional. Same key + identical request body replays the original success response (24h TTL). Same key + different body returns HTTP **409**.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answers\": {\n \"key_0\": 7640.869751596915,\n \"key_1\": 658,\n \"key_2\": 9006.685442857051,\n \"key_3\": \"string\",\n \"key_4\": 8843\n },\n \"timeSpentSeconds\": \"\",\n \"timeExpired\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "349c8ff8-0d34-4431-a73e-b085684830c1", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "forms", ":qrId", "submissions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional. Same key + identical request body replays the original success response (24h TTL). Same key + different body returns HTTP **409**.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answers\": {\n \"key_0\": 7640.869751596915,\n \"key_1\": 658,\n \"key_2\": 9006.685442857051,\n \"key_3\": \"string\",\n \"key_4\": 8843\n },\n \"timeSpentSeconds\": \"\",\n \"timeExpired\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "50befc30-3c8f-44ac-a03c-df48dc16f4f2", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "forms", ":qrId", "submissions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional. Same key + identical request body replays the original success response (24h TTL). Same key + different body returns HTTP **409**.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answers\": {\n \"key_0\": 7640.869751596915,\n \"key_1\": 658,\n \"key_2\": 9006.685442857051,\n \"key_3\": \"string\",\n \"key_4\": 8843\n },\n \"timeSpentSeconds\": \"\",\n \"timeExpired\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0ef32b26-a265-43fc-b9f9-5e19660b1daa", "name": "Idempotency-Key reused with a different request body on `POST /forms/{qrId}/submissions`", "originalRequest": { "url": { "path": [ "forms", ":qrId", "submissions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional. Same key + identical request body replays the original success response (24h TTL). Same key + different body returns HTTP **409**.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answers\": {\n \"key_0\": 7640.869751596915,\n \"key_1\": 658,\n \"key_2\": 9006.685442857051,\n \"key_3\": \"string\",\n \"key_4\": 8843\n },\n \"timeSpentSeconds\": \"\",\n \"timeExpired\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f76ce717-b634-40da-abb5-5a12c70c01ca", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "forms", ":qrId", "submissions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional. Same key + identical request body replays the original success response (24h TTL). Same key + different body returns HTTP **409**.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answers\": {\n \"key_0\": 7640.869751596915,\n \"key_1\": 658,\n \"key_2\": 9006.685442857051,\n \"key_3\": \"string\",\n \"key_4\": 8843\n },\n \"timeSpentSeconds\": \"\",\n \"timeExpired\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fc6ba1e-2915-4d72-bdc3-7f4b19b2520d", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "forms", ":qrId", "submissions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "disabled": false, "description": { "content": "Optional. Same key + identical request body replays the original success response (24h TTL). Same key + different body returns HTTP **409**.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answers\": {\n \"key_0\": 7640.869751596915,\n \"key_1\": 658,\n \"key_2\": 9006.685442857051,\n \"key_3\": \"string\",\n \"key_4\": 8843\n },\n \"timeSpentSeconds\": \"\",\n \"timeExpired\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "validate", "description": "", "item": [ { "id": "6cd13781-0c8a-4b0d-820a-5194e7a538a0", "name": "Validate submission payload (dry run)", "request": { "name": "Validate submission payload (dry run)", "description": { "content": "Dry-run validate `answers` without creating a row. Counts toward API quota. Guide: [Create a Submission](https://docs.form-qr-code-generator.com/v1/index.htm#create-submission).", "type": "text/plain" }, "url": { "path": [ "forms", ":qrId", "submissions", "validate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "TRYAWW447IK", "key": "qrId", "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answers\": {\n \"key_0\": 7640.869751596915,\n \"key_1\": 658,\n \"key_2\": 9006.685442857051,\n \"key_3\": \"string\",\n \"key_4\": 8843\n },\n \"timeSpentSeconds\": \"\",\n \"timeExpired\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0f9271ea-2fd6-4574-a47e-c007bb7cc3d5", "name": "Payload is valid for this form", "originalRequest": { "url": { "path": [ "forms", ":qrId", "submissions", "validate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answers\": {\n \"key_0\": 7640.869751596915,\n \"key_1\": 658,\n \"key_2\": 9006.685442857051,\n \"key_3\": \"string\",\n \"key_4\": 8843\n },\n \"timeSpentSeconds\": \"\",\n \"timeExpired\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"valid\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd5ae619-ef03-48f9-a823-1ecbf7c40f7a", "name": "Validation failed — see `data.fieldErrors`", "originalRequest": { "url": { "path": [ "forms", ":qrId", "submissions", "validate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answers\": {\n \"key_0\": 7640.869751596915,\n \"key_1\": 658,\n \"key_2\": 9006.685442857051,\n \"key_3\": \"string\",\n \"key_4\": 8843\n },\n \"timeSpentSeconds\": \"\",\n \"timeExpired\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"valid\": false,\n \"fieldErrors\": {\n \"key_0\": {\n \"code\": \"missing_file_ref\",\n \"message\": \"\",\n \"type\": \"\"\n },\n \"key_1\": {\n \"code\": \"invalid_body\",\n \"message\": \"\",\n \"type\": \"\"\n },\n \"key_2\": {\n \"code\": \"invalid_option\",\n \"message\": \"\",\n \"type\": \"\"\n }\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ee8524d-8006-4abc-a58b-f984ae5fec3a", "name": "Missing or invalid `Authorization: Bearer` API key.", "originalRequest": { "url": { "path": [ "forms", ":qrId", "submissions", "validate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answers\": {\n \"key_0\": 7640.869751596915,\n \"key_1\": 658,\n \"key_2\": 9006.685442857051,\n \"key_3\": \"string\",\n \"key_4\": 8843\n },\n \"timeSpentSeconds\": \"\",\n \"timeExpired\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5881d8d-0829-4704-96a0-b1447a3db735", "name": "Undocumented path or method", "originalRequest": { "url": { "path": [ "forms", ":qrId", "submissions", "validate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answers\": {\n \"key_0\": 7640.869751596915,\n \"key_1\": 658,\n \"key_2\": 9006.685442857051,\n \"key_3\": \"string\",\n \"key_4\": 8843\n },\n \"timeSpentSeconds\": \"\",\n \"timeExpired\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f9f9eb8-5bc4-4521-a045-36e263560360", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "forms", ":qrId", "submissions", "validate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answers\": {\n \"key_0\": 7640.869751596915,\n \"key_1\": 658,\n \"key_2\": 9006.685442857051,\n \"key_3\": \"string\",\n \"key_4\": 8843\n },\n \"timeSpentSeconds\": \"\",\n \"timeExpired\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d1b2c7c-75ef-4f32-affe-4e20f9be5596", "name": "Unexpected server error", "originalRequest": { "url": { "path": [ "forms", ":qrId", "submissions", "validate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"answers\": {\n \"key_0\": 7640.869751596915,\n \"key_1\": 658,\n \"key_2\": 9006.685442857051,\n \"key_3\": \"string\",\n \"key_4\": 8843\n },\n \"timeSpentSeconds\": \"\",\n \"timeExpired\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "batch-delete", "description": "", "item": [ { "id": "8255621b-46ff-424d-839a-0f54864e4eb4", "name": "Delete multiple submissions", "request": { "name": "Delete multiple submissions", "description": { "content": "Batch delete submissions by id (Admin only). Guide: [Manage Submissions](https://docs.form-qr-code-generator.com/v1/index.htm#manage-submissions).", "type": "text/plain" }, "url": { "path": [ "forms", ":qrId", "submissions", "batch-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "TRYAWW447IK", "key": "qrId", "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"qrId\": \"F52VXT\",\n \"submissionIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3e1cc5bf-4acd-479c-a663-55730729da26", "name": "Deleted", "originalRequest": { "url": { "path": [ "forms", ":qrId", "submissions", "batch-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"qrId\": \"F52VXT\",\n \"submissionIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f6296888-c1c1-4a55-88a3-f7fc56e1952a", "name": "Not admin, invalid body (**`qrId`** missing or **`submissionIds`** not an array), **form not found** for this account, or other validation error (`ApiFailedResponse`).", "originalRequest": { "url": { "path": [ "forms", ":qrId", "submissions", "batch-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"qrId\": \"F52VXT\",\n \"submissionIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e45fd16-b241-4e49-b3aa-f7b4e9a40bcb", "name": "Missing or invalid `Authorization: Bearer` API key.", "originalRequest": { "url": { "path": [ "forms", ":qrId", "submissions", "batch-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"qrId\": \"F52VXT\",\n \"submissionIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03c6f5e3-b35b-461b-b0b7-74f065ea015a", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "forms", ":qrId", "submissions", "batch-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"qrId\": \"F52VXT\",\n \"submissionIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9029463d-5153-4026-8c1e-13222d8ef8ea", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "forms", ":qrId", "submissions", "batch-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"qrId\": \"F52VXT\",\n \"submissionIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2f883a4-2d43-4747-9c7c-3aab53249275", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "forms", ":qrId", "submissions", "batch-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"qrId\": \"F52VXT\",\n \"submissionIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "analytics", "description": "", "item": [ { "id": "b92bce47-1f30-47cf-9001-87b220a52a1d", "name": "Form analytics", "request": { "name": "Form analytics", "description": { "content": "`period` must be an enum (`month`, `year`, …) — not a day count. `export=1` returns CSV link. Guide: [Form Analytics](https://docs.form-qr-code-generator.com/v1/index.htm#form-analytics).", "type": "text/plain" }, "url": { "path": [ "forms", ":qrId", "analytics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter submission-linked rows when `1` (This can only be one of 0,1)", "type": "text/plain" }, "key": "submission", "value": "1" }, { "disabled": false, "description": { "content": "Set to `1` to return a CSV download link in `data.csvUrl` instead of JSON analytics. Uses the same period and filters.", "type": "text/plain" }, "key": "export", "value": "" }, { "disabled": false, "description": { "content": "Aggregation period. Invalid values return HTTP **400** (`Invalid period…`). When `day`, pass `timestamp` (epoch seconds). When `custom`, also pass `endTimestamp`. Guide: [Form Analytics](https://docs.form-qr-code-generator.com/v1/index.htm#form-analytics). (This can only be one of day,week,month,months,year,years,custom)", "type": "text/plain" }, "key": "period", "value": "month" }, { "disabled": false, "description": { "content": "IANA timezone for bucketing scan timestamps (for example `Asia/Bangkok`). Defaults to `UTC` when omitted.", "type": "text/plain" }, "key": "tz", "value": "" }, { "disabled": false, "description": { "content": "Start of range as Unix epoch **seconds** (string). Required when `period=day`; start bound when `period=custom`.", "type": "text/plain" }, "key": "timestamp", "value": "" }, { "disabled": false, "description": { "content": "End of range as Unix epoch **seconds** (string). Required when `period=custom`.", "type": "text/plain" }, "key": "endTimestamp", "value": "" } ], "variable": [ { "type": "any", "value": "TRYAWW447IK", "key": "qrId", "disabled": false, "description": { "content": "(Required) Form id (`qrId`); uppercase letters and digits only.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "9e168255-c9b6-49b7-bcbb-bec80c3bcad5", "name": "JSON analytics summary, or a CSV download link when `export=1`.", "originalRequest": { "url": { "path": [ "forms", ":qrId", "analytics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter submission-linked rows when `1` (This can only be one of 0,1)", "type": "text/plain" }, "key": "submission", "value": "1" }, { "disabled": false, "description": { "content": "Set to `1` to return a CSV download link in `data.csvUrl` instead of JSON analytics. Uses the same period and filters.", "type": "text/plain" }, "key": "export", "value": "" }, { "disabled": false, "description": { "content": "Aggregation period. Invalid values return HTTP **400** (`Invalid period…`). When `day`, pass `timestamp` (epoch seconds). When `custom`, also pass `endTimestamp`. Guide: [Form Analytics](https://docs.form-qr-code-generator.com/v1/index.htm#form-analytics). (This can only be one of day,week,month,months,year,years,custom)", "type": "text/plain" }, "key": "period", "value": "month" }, { "disabled": false, "description": { "content": "IANA timezone for bucketing scan timestamps (for example `Asia/Bangkok`). Defaults to `UTC` when omitted.", "type": "text/plain" }, "key": "tz", "value": "" }, { "disabled": false, "description": { "content": "Start of range as Unix epoch **seconds** (string). Required when `period=day`; start bound when `period=custom`.", "type": "text/plain" }, "key": "timestamp", "value": "" }, { "disabled": false, "description": { "content": "End of range as Unix epoch **seconds** (string). Required when `period=custom`.", "type": "text/plain" }, "key": "endTimestamp", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id (`qrId`); uppercase letters and digits only.", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"form\": {\n \"qrId\": \"\",\n \"title\": \"\"\n },\n \"period\": \"\",\n \"submissionFilter\": \"\",\n \"scans\": \"\",\n \"uniqueScans\": \"\",\n \"timeseries\": {\n \"all\": [\n {\n \"count\": \"\",\n \"bucket\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\",\n \"hour\": \"\"\n },\n \"date\": \"\"\n },\n {\n \"count\": \"\",\n \"bucket\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\",\n \"hour\": \"\"\n },\n \"date\": \"\"\n }\n ],\n \"unique\": [\n {\n \"count\": \"\",\n \"bucket\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\",\n \"hour\": \"\"\n },\n \"date\": \"\"\n },\n {\n \"count\": \"\",\n \"bucket\": {\n \"year\": \"\",\n \"month\": \"\",\n \"day\": \"\",\n \"hour\": \"\"\n },\n \"date\": \"\"\n }\n ]\n }\n },\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "055ac504-3970-437d-84f0-859a67484214", "name": "Invalid **`qrId`** pattern, form not found for this account, **blocked** owner, invalid **`period`** (or missing **`timestamp`** when `period=day`, or missing **`timestamp`** / **`endTimestamp`** when `period=custom`), or other bad request (same envelope style as **`GET /forms/{qrId}`** failures).", "originalRequest": { "url": { "path": [ "forms", ":qrId", "analytics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter submission-linked rows when `1` (This can only be one of 0,1)", "type": "text/plain" }, "key": "submission", "value": "1" }, { "disabled": false, "description": { "content": "Set to `1` to return a CSV download link in `data.csvUrl` instead of JSON analytics. Uses the same period and filters.", "type": "text/plain" }, "key": "export", "value": "" }, { "disabled": false, "description": { "content": "Aggregation period. Invalid values return HTTP **400** (`Invalid period…`). When `day`, pass `timestamp` (epoch seconds). When `custom`, also pass `endTimestamp`. Guide: [Form Analytics](https://docs.form-qr-code-generator.com/v1/index.htm#form-analytics). (This can only be one of day,week,month,months,year,years,custom)", "type": "text/plain" }, "key": "period", "value": "month" }, { "disabled": false, "description": { "content": "IANA timezone for bucketing scan timestamps (for example `Asia/Bangkok`). Defaults to `UTC` when omitted.", "type": "text/plain" }, "key": "tz", "value": "" }, { "disabled": false, "description": { "content": "Start of range as Unix epoch **seconds** (string). Required when `period=day`; start bound when `period=custom`.", "type": "text/plain" }, "key": "timestamp", "value": "" }, { "disabled": false, "description": { "content": "End of range as Unix epoch **seconds** (string). Required when `period=custom`.", "type": "text/plain" }, "key": "endTimestamp", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id (`qrId`); uppercase letters and digits only.", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c9a66c9-ecbf-4cad-8f92-4b95c200bfc3", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "forms", ":qrId", "analytics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter submission-linked rows when `1` (This can only be one of 0,1)", "type": "text/plain" }, "key": "submission", "value": "1" }, { "disabled": false, "description": { "content": "Set to `1` to return a CSV download link in `data.csvUrl` instead of JSON analytics. Uses the same period and filters.", "type": "text/plain" }, "key": "export", "value": "" }, { "disabled": false, "description": { "content": "Aggregation period. Invalid values return HTTP **400** (`Invalid period…`). When `day`, pass `timestamp` (epoch seconds). When `custom`, also pass `endTimestamp`. Guide: [Form Analytics](https://docs.form-qr-code-generator.com/v1/index.htm#form-analytics). (This can only be one of day,week,month,months,year,years,custom)", "type": "text/plain" }, "key": "period", "value": "month" }, { "disabled": false, "description": { "content": "IANA timezone for bucketing scan timestamps (for example `Asia/Bangkok`). Defaults to `UTC` when omitted.", "type": "text/plain" }, "key": "tz", "value": "" }, { "disabled": false, "description": { "content": "Start of range as Unix epoch **seconds** (string). Required when `period=day`; start bound when `period=custom`.", "type": "text/plain" }, "key": "timestamp", "value": "" }, { "disabled": false, "description": { "content": "End of range as Unix epoch **seconds** (string). Required when `period=custom`.", "type": "text/plain" }, "key": "endTimestamp", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id (`qrId`); uppercase letters and digits only.", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d93dc17a-379c-4fca-90b3-45377aa7948b", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "forms", ":qrId", "analytics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter submission-linked rows when `1` (This can only be one of 0,1)", "type": "text/plain" }, "key": "submission", "value": "1" }, { "disabled": false, "description": { "content": "Set to `1` to return a CSV download link in `data.csvUrl` instead of JSON analytics. Uses the same period and filters.", "type": "text/plain" }, "key": "export", "value": "" }, { "disabled": false, "description": { "content": "Aggregation period. Invalid values return HTTP **400** (`Invalid period…`). When `day`, pass `timestamp` (epoch seconds). When `custom`, also pass `endTimestamp`. Guide: [Form Analytics](https://docs.form-qr-code-generator.com/v1/index.htm#form-analytics). (This can only be one of day,week,month,months,year,years,custom)", "type": "text/plain" }, "key": "period", "value": "month" }, { "disabled": false, "description": { "content": "IANA timezone for bucketing scan timestamps (for example `Asia/Bangkok`). Defaults to `UTC` when omitted.", "type": "text/plain" }, "key": "tz", "value": "" }, { "disabled": false, "description": { "content": "Start of range as Unix epoch **seconds** (string). Required when `period=day`; start bound when `period=custom`.", "type": "text/plain" }, "key": "timestamp", "value": "" }, { "disabled": false, "description": { "content": "End of range as Unix epoch **seconds** (string). Required when `period=custom`.", "type": "text/plain" }, "key": "endTimestamp", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id (`qrId`); uppercase letters and digits only.", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc2d0997-4a28-4636-b022-a4617159ad95", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "forms", ":qrId", "analytics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter submission-linked rows when `1` (This can only be one of 0,1)", "type": "text/plain" }, "key": "submission", "value": "1" }, { "disabled": false, "description": { "content": "Set to `1` to return a CSV download link in `data.csvUrl` instead of JSON analytics. Uses the same period and filters.", "type": "text/plain" }, "key": "export", "value": "" }, { "disabled": false, "description": { "content": "Aggregation period. Invalid values return HTTP **400** (`Invalid period…`). When `day`, pass `timestamp` (epoch seconds). When `custom`, also pass `endTimestamp`. Guide: [Form Analytics](https://docs.form-qr-code-generator.com/v1/index.htm#form-analytics). (This can only be one of day,week,month,months,year,years,custom)", "type": "text/plain" }, "key": "period", "value": "month" }, { "disabled": false, "description": { "content": "IANA timezone for bucketing scan timestamps (for example `Asia/Bangkok`). Defaults to `UTC` when omitted.", "type": "text/plain" }, "key": "tz", "value": "" }, { "disabled": false, "description": { "content": "Start of range as Unix epoch **seconds** (string). Required when `period=day`; start bound when `period=custom`.", "type": "text/plain" }, "key": "timestamp", "value": "" }, { "disabled": false, "description": { "content": "End of range as Unix epoch **seconds** (string). Required when `period=custom`.", "type": "text/plain" }, "key": "endTimestamp", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id (`qrId`); uppercase letters and digits only.", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93ffa0fd-b3fb-4549-a412-e5b0fac075c4", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "forms", ":qrId", "analytics" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter submission-linked rows when `1` (This can only be one of 0,1)", "type": "text/plain" }, "key": "submission", "value": "1" }, { "disabled": false, "description": { "content": "Set to `1` to return a CSV download link in `data.csvUrl` instead of JSON analytics. Uses the same period and filters.", "type": "text/plain" }, "key": "export", "value": "" }, { "disabled": false, "description": { "content": "Aggregation period. Invalid values return HTTP **400** (`Invalid period…`). When `day`, pass `timestamp` (epoch seconds). When `custom`, also pass `endTimestamp`. Guide: [Form Analytics](https://docs.form-qr-code-generator.com/v1/index.htm#form-analytics). (This can only be one of day,week,month,months,year,years,custom)", "type": "text/plain" }, "key": "period", "value": "month" }, { "disabled": false, "description": { "content": "IANA timezone for bucketing scan timestamps (for example `Asia/Bangkok`). Defaults to `UTC` when omitted.", "type": "text/plain" }, "key": "tz", "value": "" }, { "disabled": false, "description": { "content": "Start of range as Unix epoch **seconds** (string). Required when `period=day`; start bound when `period=custom`.", "type": "text/plain" }, "key": "timestamp", "value": "" }, { "disabled": false, "description": { "content": "End of range as Unix epoch **seconds** (string). Required when `period=custom`.", "type": "text/plain" }, "key": "endTimestamp", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) Form id (`qrId`); uppercase letters and digits only.", "type": "text/plain" }, "type": "any", "value": "TRYAWW447IK", "key": "qrId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "account", "description": "", "item": [ { "name": "uploads", "description": "", "item": [ { "id": "4d00b188-30a1-4b08-9e78-04bb5fa05db0", "name": "List uploaded account logos", "request": { "name": "List uploaded account logos", "description": { "content": "List account logo uploads. Guide: [Account API](https://docs.form-qr-code-generator.com/v1/index.htm#account-api).", "type": "text/plain" }, "url": { "path": [ "account", "uploads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only `logo` is supported on the public API. (This can only be one of logo)", "type": "text/plain" }, "key": "category", "value": "logo" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4a63fe83-01d9-4326-a556-09f67fee42b1", "name": "Logo list (may be empty)", "originalRequest": { "url": { "path": [ "account", "uploads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only `logo` is supported on the public API. (This can only be one of logo)", "type": "text/plain" }, "key": "category", "value": "logo" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": [\n {\n \"fileId\": \"\",\n \"fileUrl\": \"\",\n \"mime\": \"\",\n \"fileUsed\": \"\"\n },\n {\n \"fileId\": \"\",\n \"fileUrl\": \"\",\n \"mime\": \"\",\n \"fileUsed\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc19a44d-f102-4bad-9800-7bed17eb5477", "name": "Unsupported category value", "originalRequest": { "url": { "path": [ "account", "uploads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only `logo` is supported on the public API. (This can only be one of logo)", "type": "text/plain" }, "key": "category", "value": "logo" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97e594ef-e752-4c36-9658-a43702d34691", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "account", "uploads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only `logo` is supported on the public API. (This can only be one of logo)", "type": "text/plain" }, "key": "category", "value": "logo" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9dedaec0-e606-47ca-ace9-5189b3868383", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "account", "uploads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only `logo` is supported on the public API. (This can only be one of logo)", "type": "text/plain" }, "key": "category", "value": "logo" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b44d86aa-fcbf-43df-a59a-dbf1d1cb4855", "name": "Unexpected error while loading the list", "originalRequest": { "url": { "path": [ "account", "uploads" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Only `logo` is supported on the public API. (This can only be one of logo)", "type": "text/plain" }, "key": "category", "value": "logo" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b6abceac-901c-450b-af34-75ba691d088d", "name": "Upload account logo", "request": { "name": "Upload account logo", "description": { "content": "Upload account logo (`category=logo`, multipart `userFile`, max 20 MB). Guide: [Upload APIs Compared](https://docs.form-qr-code-generator.com/v1/index.htm#upload-apis-compared).", "type": "text/plain" }, "url": { "path": [ "account", "uploads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The File to Upload", "type": "text/plain" }, "key": "userFile", "type": "file" }, { "description": { "content": "(Required) Category of the file", "type": "text/plain" }, "key": "category", "value": "logo", "type": "text" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "72f2c37a-7eb9-4f50-a5e4-43f062a864fc", "name": "Logo stored; returns normalized `File` record in public envelope when applicable", "originalRequest": { "url": { "path": [ "account", "uploads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The File to Upload", "type": "text/plain" }, "key": "userFile", "type": "file" }, { "description": { "content": "(Required) Category of the file", "type": "text/plain" }, "key": "category", "value": "logo", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea342f5e-e12d-4abe-88c1-3646eceb861a", "name": "Missing file or unsupported image type", "originalRequest": { "url": { "path": [ "account", "uploads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The File to Upload", "type": "text/plain" }, "key": "userFile", "type": "file" }, { "description": { "content": "(Required) Category of the file", "type": "text/plain" }, "key": "category", "value": "logo", "type": "text" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e138242f-d025-4792-a4b1-f18d954420ad", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "account", "uploads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The File to Upload", "type": "text/plain" }, "key": "userFile", "type": "file" }, { "description": { "content": "(Required) Category of the file", "type": "text/plain" }, "key": "category", "value": "logo", "type": "text" } ] } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c0a6a30d-53b1-4469-9a26-220b6a63ec67", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "account", "uploads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The File to Upload", "type": "text/plain" }, "key": "userFile", "type": "file" }, { "description": { "content": "(Required) Category of the file", "type": "text/plain" }, "key": "category", "value": "logo", "type": "text" } ] } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebf40c3e-5642-48c9-9c2b-a2a38e3e31b3", "name": "Unexpected failure while storing the file, or file exceeds 20 MB (`message`: `uploaded file is too large`).", "originalRequest": { "url": { "path": [ "account", "uploads" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The File to Upload", "type": "text/plain" }, "key": "userFile", "type": "file" }, { "description": { "content": "(Required) Category of the file", "type": "text/plain" }, "key": "category", "value": "logo", "type": "text" } ] } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "webhook", "description": "", "item": [ { "id": "7e0f5af5-94d3-4d89-9259-a4cce3e28030", "name": "Get account webhook settings", "request": { "name": "Get account webhook settings", "description": { "content": "Read webhook URL and signing secret. Owner/Admin only. Guide: [Webhooks](https://docs.form-qr-code-generator.com/v1/index.htm#webhook-api).", "type": "text/plain" }, "url": { "path": [ "account", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b86989e2-7f25-4282-8d61-2fa829053b24", "name": "Webhook settings", "originalRequest": { "url": { "path": [ "account", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"enabled\": false,\n \"url\": \"\",\n \"secret\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da6104ec-bc64-47b5-986c-8b2db9838151", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "account", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f670ccac-cab3-4b7a-9f93-7121b2b7bc7b", "name": "Authenticated but not allowed for this action. Common cases: **Viewer** on `POST /forms`; **Editor** or **Viewer** on account webhook routes; **Editor** or **Viewer** on team management routes. See guide [Core Concepts](https://docs.form-qr-code-generator.com/v1/index.htm#core-concepts).", "originalRequest": { "url": { "path": [ "account", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a14e8cf-5378-4093-981d-2bec0e87082c", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "account", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "70ece735-443c-4bfd-8198-ba7ca71a17a8", "name": "Update account webhook settings", "request": { "name": "Update account webhook settings", "description": { "content": "Enable, disable, or rotate webhook secret. Owner/Admin only. Guide: [Webhooks](https://docs.form-qr-code-generator.com/v1/index.htm#webhook-api).", "type": "text/plain" }, "url": { "path": [ "account", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"enabled\": false,\n \"url\": \"\",\n \"rotateSecret\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2be34561-94f7-4c58-8500-7dc7b45354c5", "name": "Updated webhook settings", "originalRequest": { "url": { "path": [ "account", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"enabled\": false,\n \"url\": \"\",\n \"rotateSecret\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"enabled\": false,\n \"url\": \"\",\n \"secret\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b51fb77-3f5d-46d7-9e34-fb895e668a83", "name": "Invalid URL or payload", "originalRequest": { "url": { "path": [ "account", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"enabled\": false,\n \"url\": \"\",\n \"rotateSecret\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ed32359-cca9-45c1-ac03-15a2683eff0d", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "account", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"enabled\": false,\n \"url\": \"\",\n \"rotateSecret\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a8dd7bd3-f5d7-436d-aa9e-8a96adccd362", "name": "Authenticated but not allowed for this action. Common cases: **Viewer** on `POST /forms`; **Editor** or **Viewer** on account webhook routes; **Editor** or **Viewer** on team management routes. See guide [Core Concepts](https://docs.form-qr-code-generator.com/v1/index.htm#core-concepts).", "originalRequest": { "url": { "path": [ "account", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"enabled\": false,\n \"url\": \"\",\n \"rotateSecret\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eadf6952-e187-4fd5-b63d-9cf869e6e2b0", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "account", "webhook" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"enabled\": false,\n \"url\": \"\",\n \"rotateSecret\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "submissions", "description": "", "item": [ { "name": "{submissionId}", "description": "", "item": [ { "id": "aafce22e-ec37-45c9-89da-b15b89bcf5ec", "name": "Get one submission", "request": { "name": "Get one submission", "description": { "content": "Fetch one submission by id. Unknown id → **400**. Guide: [Read Submissions](https://docs.form-qr-code-generator.com/v1/index.htm#read-submissions).", "type": "text/plain" }, "url": { "path": [ "submissions", ":submissionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "47E4B6cd0006E04e05db854F", "key": "submissionId", "disabled": false, "description": { "content": "(Required) Submission id (24-character hex submission id)", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6d20c848-60db-4c1a-913e-b21812c4fe95", "name": "Submission found", "originalRequest": { "url": { "path": [ "submissions", ":submissionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Submission id (24-character hex submission id)", "type": "text/plain" }, "type": "any", "value": "47E4B6cd0006E04e05db854F", "key": "submissionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"key_0\": true,\n \"key_1\": 3930\n },\n \"form\": {\n \"fields\": [\n {\n \"key\": \"\",\n \"type\": \"\",\n \"option\": {\n \"key_0\": 351\n },\n \"quizConfig\": {\n \"key_0\": 9817,\n \"key_1\": true,\n \"key_2\": 6388\n }\n },\n {\n \"key\": \"\",\n \"type\": \"\",\n \"option\": {\n \"key_0\": \"string\",\n \"key_1\": 4327\n },\n \"quizConfig\": {\n \"key_0\": true\n }\n }\n ],\n \"title\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19a2332e-3394-4c1e-bff3-18ea15661de7", "name": "Invalid id format, submission not found, or not allowed to view", "originalRequest": { "url": { "path": [ "submissions", ":submissionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Submission id (24-character hex submission id)", "type": "text/plain" }, "type": "any", "value": "47E4B6cd0006E04e05db854F", "key": "submissionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2bb444b8-f0d6-4f7f-be94-cf1e61400c62", "name": "Missing or invalid `Authorization: Bearer` API key.", "originalRequest": { "url": { "path": [ "submissions", ":submissionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Submission id (24-character hex submission id)", "type": "text/plain" }, "type": "any", "value": "47E4B6cd0006E04e05db854F", "key": "submissionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e65dc25c-3046-47b5-984f-d10251ccf4a6", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "submissions", ":submissionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Submission id (24-character hex submission id)", "type": "text/plain" }, "type": "any", "value": "47E4B6cd0006E04e05db854F", "key": "submissionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c78f6c5-bca8-4f6b-87b4-60afae71ee4b", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "submissions", ":submissionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Submission id (24-character hex submission id)", "type": "text/plain" }, "type": "any", "value": "47E4B6cd0006E04e05db854F", "key": "submissionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67874418-4916-4239-bf16-db26bccc8559", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "submissions", ":submissionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Submission id (24-character hex submission id)", "type": "text/plain" }, "type": "any", "value": "47E4B6cd0006E04e05db854F", "key": "submissionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ddfaf57d-d251-442a-b218-d2373e9a279b", "name": "Update a submission", "request": { "name": "Update a submission", "description": { "content": "Update submission `answers`. Viewer cannot edit. Guide: [Manage Submissions](https://docs.form-qr-code-generator.com/v1/index.htm#manage-submissions).", "type": "text/plain" }, "url": { "path": [ "submissions", ":submissionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "submissionId", "disabled": false, "description": { "content": "(Required) Submission id", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"answers\": {\n \"key_0\": 7785.85905316006,\n \"key_1\": 7714.4741718274145,\n \"key_2\": 6975\n },\n \"timeSpentSeconds\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0b6adaee-8cee-4bf3-9989-f4170b7bbf5c", "name": "Updated", "originalRequest": { "url": { "path": [ "submissions", ":submissionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Submission id", "type": "text/plain" }, "type": "any", "value": "", "key": "submissionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"answers\": {\n \"key_0\": 7785.85905316006,\n \"key_1\": 7714.4741718274145,\n \"key_2\": 6975\n },\n \"timeSpentSeconds\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe400cc5-6c0c-4036-8933-c6269cf164bf", "name": "Not allowed or validation error", "originalRequest": { "url": { "path": [ "submissions", ":submissionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Submission id", "type": "text/plain" }, "type": "any", "value": "", "key": "submissionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"answers\": {\n \"key_0\": 7785.85905316006,\n \"key_1\": 7714.4741718274145,\n \"key_2\": 6975\n },\n \"timeSpentSeconds\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ccbaa7c-3770-4c92-b0cd-0edcf2a2f7d9", "name": "Missing or invalid `Authorization: Bearer` API key.", "originalRequest": { "url": { "path": [ "submissions", ":submissionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Submission id", "type": "text/plain" }, "type": "any", "value": "", "key": "submissionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"answers\": {\n \"key_0\": 7785.85905316006,\n \"key_1\": 7714.4741718274145,\n \"key_2\": 6975\n },\n \"timeSpentSeconds\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84878857-22a7-4172-961c-a2ccfdb1e038", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "submissions", ":submissionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Submission id", "type": "text/plain" }, "type": "any", "value": "", "key": "submissionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"answers\": {\n \"key_0\": 7785.85905316006,\n \"key_1\": 7714.4741718274145,\n \"key_2\": 6975\n },\n \"timeSpentSeconds\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ded341a7-0fd6-4155-8c67-d5c80d9c3767", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "submissions", ":submissionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Submission id", "type": "text/plain" }, "type": "any", "value": "", "key": "submissionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"answers\": {\n \"key_0\": 7785.85905316006,\n \"key_1\": 7714.4741718274145,\n \"key_2\": 6975\n },\n \"timeSpentSeconds\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4792c29-5b65-470d-ae6e-da646d3f8a1d", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "submissions", ":submissionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Submission id", "type": "text/plain" }, "type": "any", "value": "", "key": "submissionId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"answers\": {\n \"key_0\": 7785.85905316006,\n \"key_1\": 7714.4741718274145,\n \"key_2\": 6975\n },\n \"timeSpentSeconds\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8d0daaa8-e384-4911-abad-4b2fc975dfee", "name": "Delete one submission", "request": { "name": "Delete one submission", "description": { "content": "Delete one submission (Admin only). Guide: [Manage Submissions](https://docs.form-qr-code-generator.com/v1/index.htm#manage-submissions).", "type": "text/plain" }, "url": { "path": [ "submissions", ":submissionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "submissionId", "disabled": false, "description": { "content": "(Required) Submission identifier (24-character hex string).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d25e52b0-d9da-4156-9f9a-90ce76f1f0d9", "name": "Deleted", "originalRequest": { "url": { "path": [ "submissions", ":submissionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Submission identifier (24-character hex string).", "type": "text/plain" }, "type": "any", "value": "", "key": "submissionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {}\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7be9b489-c7a9-481e-bb55-e549da94f599", "name": "Not allowed or error", "originalRequest": { "url": { "path": [ "submissions", ":submissionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Submission identifier (24-character hex string).", "type": "text/plain" }, "type": "any", "value": "", "key": "submissionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63981265-0e56-420a-9b84-5527f1b7d038", "name": "Missing or invalid `Authorization: Bearer` API key.", "originalRequest": { "url": { "path": [ "submissions", ":submissionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Submission identifier (24-character hex string).", "type": "text/plain" }, "type": "any", "value": "", "key": "submissionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a579dfe-7f6f-4160-acb8-83b3c0195779", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "submissions", ":submissionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Submission identifier (24-character hex string).", "type": "text/plain" }, "type": "any", "value": "", "key": "submissionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69737910-baa2-47cb-be22-66660f6b5d3f", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "submissions", ":submissionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Submission identifier (24-character hex string).", "type": "text/plain" }, "type": "any", "value": "", "key": "submissionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab9981c7-5d1c-4a59-bcab-1d47166db476", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "submissions", ":submissionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Submission identifier (24-character hex string).", "type": "text/plain" }, "type": "any", "value": "", "key": "submissionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "team", "description": "", "item": [ { "name": "members", "description": "", "item": [ { "id": "0de79037-4060-480e-bf3c-163feb79a0fe", "name": "List team members", "request": { "name": "List team members", "description": { "content": "List team members. Owner/Admin only. Guide: [Team API](https://docs.form-qr-code-generator.com/v1/index.htm#team-api).", "type": "text/plain" }, "url": { "path": [ "team", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e5d53467-d0a5-4f33-8463-f391c35e2c6d", "name": "Success", "originalRequest": { "url": { "path": [ "team", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"members\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"userType\": \"\",\n \"blocked\": \"\",\n \"teamName\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"userType\": \"\",\n \"blocked\": \"\",\n \"teamName\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bfb6aee-0fe8-4aa4-81b3-eeeafaac85c6", "name": "Validation error or owner not found", "originalRequest": { "url": { "path": [ "team", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02faa8c2-7367-47d0-8b4e-51a97098c1e7", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "team", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "63fe0cf8-3e72-4126-8085-40e1ec47dea7", "name": "Authenticated but not allowed for this action. Common cases: **Viewer** on `POST /forms`; **Editor** or **Viewer** on account webhook routes; **Editor** or **Viewer** on team management routes. See guide [Core Concepts](https://docs.form-qr-code-generator.com/v1/index.htm#core-concepts).", "originalRequest": { "url": { "path": [ "team", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d15064b8-f5da-40b4-8932-deb39bce453e", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "team", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e68d4c1-b2f2-478c-9fea-a9d358262bd0", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "team", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "329e0fce-8114-472c-9d3c-a9106ae5501e", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "team", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9320434e-2982-4190-a3a8-9ce2c50545a4", "name": "Create team member", "request": { "name": "Create team member", "description": { "content": "Add team member (Business+ plan, Owner/Admin only). Guide: [Team API](https://docs.form-qr-code-generator.com/v1/index.htm#team-api).", "type": "text/plain" }, "url": { "path": [ "team", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": \"\",\n \"userType\": \"\",\n \"name\": \"\",\n \"subDomainIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1f97e22e-975f-4faa-a602-dd93720768af", "name": "Created", "originalRequest": { "url": { "path": [ "team", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": \"\",\n \"userType\": \"\",\n \"name\": \"\",\n \"subDomainIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"message\": \"\",\n \"member\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"userType\": \"\",\n \"blocked\": \"\",\n \"teamName\": \"\"\n },\n \"teamName\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f7ff4302-b467-49d4-8a6a-e35041a5d867", "name": "Validation error, plan limit, or duplicate user", "originalRequest": { "url": { "path": [ "team", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": \"\",\n \"userType\": \"\",\n \"name\": \"\",\n \"subDomainIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "314cfd16-b1d0-4e26-9dde-fdb524b8547c", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "team", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": \"\",\n \"userType\": \"\",\n \"name\": \"\",\n \"subDomainIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "651cdfe5-d172-40d3-a334-978caf75bd53", "name": "Authenticated but not allowed for this action. Common cases: **Viewer** on `POST /forms`; **Editor** or **Viewer** on account webhook routes; **Editor** or **Viewer** on team management routes. See guide [Core Concepts](https://docs.form-qr-code-generator.com/v1/index.htm#core-concepts).", "originalRequest": { "url": { "path": [ "team", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": \"\",\n \"userType\": \"\",\n \"name\": \"\",\n \"subDomainIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b1f897f4-d378-4fd8-8a7f-8ae64bfff684", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "team", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": \"\",\n \"userType\": \"\",\n \"name\": \"\",\n \"subDomainIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fd1b5503-5f32-4813-9d9d-6d70b301df42", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "team", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": \"\",\n \"userType\": \"\",\n \"name\": \"\",\n \"subDomainIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17374b57-bc3d-4574-92e4-8b76311a0fc9", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "team", "members" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"password\": \"\",\n \"userType\": \"\",\n \"name\": \"\",\n \"subDomainIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{memberId}", "description": "", "item": [ { "id": "291eeaef-b5f5-4d7d-8e25-86500a70bfc5", "name": "Update team member", "request": { "name": "Update team member", "description": { "content": "Update member name, email, role, or blocked status. Owner/Admin only. Guide: [Team API](https://docs.form-qr-code-generator.com/v1/index.htm#team-api).", "type": "text/plain" }, "url": { "path": [ "team", "members", ":memberId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "memberId", "disabled": false, "description": { "content": "(Required) Team member user id (from `GET /team/members`).", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"email\": \"\",\n \"block\": \"\",\n \"teamName\": \"\",\n \"userType\": \"\",\n \"pass\": \"\",\n \"subDomainIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1f03a8a7-bb03-4a4a-a658-05efd22387ad", "name": "Updated", "originalRequest": { "url": { "path": [ "team", "members", ":memberId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Team member user id (from `GET /team/members`).", "type": "text/plain" }, "type": "any", "value": "", "key": "memberId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"email\": \"\",\n \"block\": \"\",\n \"teamName\": \"\",\n \"userType\": \"\",\n \"pass\": \"\",\n \"subDomainIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"message\": \"\",\n \"member\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"userType\": \"\",\n \"blocked\": \"\",\n \"teamName\": \"\"\n },\n \"teamName\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b994e7d5-10c6-462d-84cb-57b44b8b86df", "name": "Validation error or member not found", "originalRequest": { "url": { "path": [ "team", "members", ":memberId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Team member user id (from `GET /team/members`).", "type": "text/plain" }, "type": "any", "value": "", "key": "memberId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"email\": \"\",\n \"block\": \"\",\n \"teamName\": \"\",\n \"userType\": \"\",\n \"pass\": \"\",\n \"subDomainIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c759cff-cf03-4073-90e8-9af13db228ce", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "team", "members", ":memberId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Team member user id (from `GET /team/members`).", "type": "text/plain" }, "type": "any", "value": "", "key": "memberId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"email\": \"\",\n \"block\": \"\",\n \"teamName\": \"\",\n \"userType\": \"\",\n \"pass\": \"\",\n \"subDomainIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "972fdf8a-7524-415b-b434-98b9c50576e1", "name": "Authenticated but not allowed for this action. Common cases: **Viewer** on `POST /forms`; **Editor** or **Viewer** on account webhook routes; **Editor** or **Viewer** on team management routes. See guide [Core Concepts](https://docs.form-qr-code-generator.com/v1/index.htm#core-concepts).", "originalRequest": { "url": { "path": [ "team", "members", ":memberId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Team member user id (from `GET /team/members`).", "type": "text/plain" }, "type": "any", "value": "", "key": "memberId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"email\": \"\",\n \"block\": \"\",\n \"teamName\": \"\",\n \"userType\": \"\",\n \"pass\": \"\",\n \"subDomainIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1772a727-2ee0-47a1-849f-e3359bf40f88", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "team", "members", ":memberId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Team member user id (from `GET /team/members`).", "type": "text/plain" }, "type": "any", "value": "", "key": "memberId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"email\": \"\",\n \"block\": \"\",\n \"teamName\": \"\",\n \"userType\": \"\",\n \"pass\": \"\",\n \"subDomainIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da36440c-f866-42d4-9332-f0664c748573", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "team", "members", ":memberId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Team member user id (from `GET /team/members`).", "type": "text/plain" }, "type": "any", "value": "", "key": "memberId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"email\": \"\",\n \"block\": \"\",\n \"teamName\": \"\",\n \"userType\": \"\",\n \"pass\": \"\",\n \"subDomainIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0879f2b0-8307-420b-8fcd-90030f50c567", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "team", "members", ":memberId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Team member user id (from `GET /team/members`).", "type": "text/plain" }, "type": "any", "value": "", "key": "memberId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"email\": \"\",\n \"block\": \"\",\n \"teamName\": \"\",\n \"userType\": \"\",\n \"pass\": \"\",\n \"subDomainIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f0ca9f4f-58a1-4c13-9fc5-a97e77ffe1be", "name": "Delete team member", "request": { "name": "Delete team member", "description": { "content": "Remove team member. Owner/Admin only. Guide: [Team API](https://docs.form-qr-code-generator.com/v1/index.htm#team-api).", "type": "text/plain" }, "url": { "path": [ "team", "members", ":memberId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "memberId", "disabled": false, "description": { "content": "(Required) Team member user id (from `GET /team/members`).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "94b37cd3-5009-41c3-a338-559957300bf0", "name": "Deleted", "originalRequest": { "url": { "path": [ "team", "members", ":memberId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Team member user id (from `GET /team/members`).", "type": "text/plain" }, "type": "any", "value": "", "key": "memberId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"message\": \"\",\n \"member\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"userType\": \"\",\n \"blocked\": \"\",\n \"teamName\": \"\"\n },\n \"teamName\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02ed875d-2b6c-4fe4-a6f6-c90029569647", "name": "Validation error or member not found", "originalRequest": { "url": { "path": [ "team", "members", ":memberId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Team member user id (from `GET /team/members`).", "type": "text/plain" }, "type": "any", "value": "", "key": "memberId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d99efca-884f-4203-b114-a32b40d76e80", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "team", "members", ":memberId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Team member user id (from `GET /team/members`).", "type": "text/plain" }, "type": "any", "value": "", "key": "memberId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "565d30da-2948-4fd6-9750-e156b7cb4a03", "name": "Authenticated but not allowed for this action. Common cases: **Viewer** on `POST /forms`; **Editor** or **Viewer** on account webhook routes; **Editor** or **Viewer** on team management routes. See guide [Core Concepts](https://docs.form-qr-code-generator.com/v1/index.htm#core-concepts).", "originalRequest": { "url": { "path": [ "team", "members", ":memberId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Team member user id (from `GET /team/members`).", "type": "text/plain" }, "type": "any", "value": "", "key": "memberId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af4c9cb8-78d0-4eb1-ba60-b82df4064e4f", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "team", "members", ":memberId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Team member user id (from `GET /team/members`).", "type": "text/plain" }, "type": "any", "value": "", "key": "memberId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5a1b8dc-aa91-455f-888d-8c94f407999d", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "team", "members", ":memberId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Team member user id (from `GET /team/members`).", "type": "text/plain" }, "type": "any", "value": "", "key": "memberId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0ed8b1b-91b0-4fa9-b8ba-44e45b120dc7", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "team", "members", ":memberId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Team member user id (from `GET /team/members`).", "type": "text/plain" }, "type": "any", "value": "", "key": "memberId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "reset-password", "description": "", "item": [ { "id": "163db8e2-624a-4616-8baa-8537ab2a11f6", "name": "Reset member password", "request": { "name": "Reset member password", "description": { "content": "Member changes their own password (`oldPass`, `newPass`, `confirmPass`). Use that member's API key. Guide: [Team API](https://docs.form-qr-code-generator.com/v1/index.htm#team-api).", "type": "text/plain" }, "url": { "path": [ "team", "members", ":memberId", "reset-password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "memberId", "disabled": false, "description": { "content": "(Required) Team member user id (from `GET /team/members`).", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"oldPass\": \"\",\n \"newPass\": \"\",\n \"confirmPass\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0fecc665-c99d-4ac6-aad1-37eea6121d1e", "name": "Password updated", "originalRequest": { "url": { "path": [ "team", "members", ":memberId", "reset-password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Team member user id (from `GET /team/members`).", "type": "text/plain" }, "type": "any", "value": "", "key": "memberId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"oldPass\": \"\",\n \"newPass\": \"\",\n \"confirmPass\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"message\": \"\",\n \"member\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"userType\": \"\",\n \"blocked\": \"\",\n \"teamName\": \"\"\n },\n \"teamName\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3024cf53-270e-4add-967c-29b7c8ebd7e6", "name": "Validation or password mismatch", "originalRequest": { "url": { "path": [ "team", "members", ":memberId", "reset-password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Team member user id (from `GET /team/members`).", "type": "text/plain" }, "type": "any", "value": "", "key": "memberId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"oldPass\": \"\",\n \"newPass\": \"\",\n \"confirmPass\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c6079be-395b-46fa-acba-708e171842ff", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "team", "members", ":memberId", "reset-password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Team member user id (from `GET /team/members`).", "type": "text/plain" }, "type": "any", "value": "", "key": "memberId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"oldPass\": \"\",\n \"newPass\": \"\",\n \"confirmPass\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0f06489-05bd-46b2-b638-bb9cfd17448b", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "team", "members", ":memberId", "reset-password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Team member user id (from `GET /team/members`).", "type": "text/plain" }, "type": "any", "value": "", "key": "memberId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"oldPass\": \"\",\n \"newPass\": \"\",\n \"confirmPass\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6041c593-206b-4d0e-8bf9-c05e99da5a2b", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "team", "members", ":memberId", "reset-password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Team member user id (from `GET /team/members`).", "type": "text/plain" }, "type": "any", "value": "", "key": "memberId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"oldPass\": \"\",\n \"newPass\": \"\",\n \"confirmPass\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa5936ac-00bb-418a-9eaf-76acb10c4c52", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "team", "members", ":memberId", "reset-password" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Team member user id (from `GET /team/members`).", "type": "text/plain" }, "type": "any", "value": "", "key": "memberId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"oldPass\": \"\",\n \"newPass\": \"\",\n \"confirmPass\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "id": "300e2aa5-3f23-44cf-91fe-211a1122c7ff", "name": "Update team name", "request": { "name": "Update team name", "description": { "content": "Rename team (requires account password). Owner/Admin only. Guide: [Team API](https://docs.form-qr-code-generator.com/v1/index.htm#team-api).", "type": "text/plain" }, "url": { "path": [ "team" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"teamName\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a9b818e1-c742-47bd-ae47-ea1fa4709b41", "name": "Updated", "originalRequest": { "url": { "path": [ "team" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"teamName\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"message\": \"\",\n \"member\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"userType\": \"\",\n \"blocked\": \"\",\n \"teamName\": \"\"\n },\n \"teamName\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0fbf7dc-2cbe-45f9-9521-062aaeb8c9df", "name": "Validation or password mismatch", "originalRequest": { "url": { "path": [ "team" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"teamName\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2adbf149-d448-4e4e-9497-3820220ba028", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "team" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"teamName\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfa7eb56-c295-47fe-8253-6be0f1ce1655", "name": "Authenticated but not allowed for this action. Common cases: **Viewer** on `POST /forms`; **Editor** or **Viewer** on account webhook routes; **Editor** or **Viewer** on team management routes. See guide [Core Concepts](https://docs.form-qr-code-generator.com/v1/index.htm#core-concepts).", "originalRequest": { "url": { "path": [ "team" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"teamName\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5b5a1d3-a337-4f69-874c-7aa6f330db94", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "team" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"teamName\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4a706f31-95a1-4e39-bc50-70cb05353ba5", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "team" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"teamName\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06c59129-1697-4b47-8a2e-0d542f150493", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "team" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"teamName\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "form-templates", "description": "", "item": [ { "id": "afe1b489-6eed-4294-9b9d-88df9b34a70d", "name": "Create a form template", "request": { "name": "Create a form template", "description": { "content": "Save private reusable layout on your account. Guide: [Form Templates API](https://docs.form-qr-code-generator.com/v1/index.htm#form-templates-api).", "type": "text/plain" }, "url": { "path": [ "form-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"categoryId\": \"\",\n \"title\": \"\",\n \"form\": {\n \"key_0\": 7686.478141888271,\n \"key_1\": 1438.6106840005564\n },\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2a5d39b2-13a4-4556-9f5c-26bf444bf7c1", "name": "Template created", "originalRequest": { "url": { "path": [ "form-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"categoryId\": \"\",\n \"title\": \"\",\n \"form\": {\n \"key_0\": 7686.478141888271,\n \"key_1\": 1438.6106840005564\n },\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"message\": \"\",\n \"member\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"userType\": \"\",\n \"blocked\": \"\",\n \"teamName\": \"\"\n },\n \"teamName\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8158ca65-a7de-4f5a-9b50-39a97ca1391d", "name": "Validation or business rule failure", "originalRequest": { "url": { "path": [ "form-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"categoryId\": \"\",\n \"title\": \"\",\n \"form\": {\n \"key_0\": 7686.478141888271,\n \"key_1\": 1438.6106840005564\n },\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1bd50b66-a73c-4988-982a-15ba478ed396", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "form-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"categoryId\": \"\",\n \"title\": \"\",\n \"form\": {\n \"key_0\": 7686.478141888271,\n \"key_1\": 1438.6106840005564\n },\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15ca12f1-79a9-4eb9-b1b7-88e08181c568", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "form-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"categoryId\": \"\",\n \"title\": \"\",\n \"form\": {\n \"key_0\": 7686.478141888271,\n \"key_1\": 1438.6106840005564\n },\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3910c2e0-437e-4ca9-8cd8-865a48c0058e", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "form-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"categoryId\": \"\",\n \"title\": \"\",\n \"form\": {\n \"key_0\": 7686.478141888271,\n \"key_1\": 1438.6106840005564\n },\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e6bf2d3-bda0-47d9-80a0-2c9c69d22b0c", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "form-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"categoryId\": \"\",\n \"title\": \"\",\n \"form\": {\n \"key_0\": 7686.478141888271,\n \"key_1\": 1438.6106840005564\n },\n \"description\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a7b42bfb-e4de-4fd2-a345-dda3aa3f0db8", "name": "List public templates in a category", "request": { "name": "List public templates in a category", "description": { "content": "Returns public templates for `categoryId`, including templates in child categories. Response items include preview image metadata only (not full field definitions).", "type": "text/plain" }, "url": { "path": [ "form-templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Category id (24-character hex string).", "type": "text/plain" }, "key": "categoryId", "value": "" }, { "disabled": false, "description": { "content": "Maximum templates to return; `0` means no limit.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "462ce204-0c40-4048-a1d3-aa5a076eba7b", "name": "Template list", "originalRequest": { "url": { "path": [ "form-templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Category id (24-character hex string).", "type": "text/plain" }, "key": "categoryId", "value": "" }, { "disabled": false, "description": { "content": "Maximum templates to return; `0` means no limit.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": [\n {\n \"title\": \"\",\n \"description\": \"\",\n \"categoryId\": \"\",\n \"categoryName\": \"\",\n \"form\": {\n \"previewImage\": {\n \"fileUrl\": \"\",\n \"fileId\": \"\"\n }\n },\n \"id\": \"\"\n },\n {\n \"title\": \"\",\n \"description\": \"\",\n \"categoryId\": \"\",\n \"categoryName\": \"\",\n \"form\": {\n \"previewImage\": {\n \"fileUrl\": \"\",\n \"fileId\": \"\"\n }\n },\n \"id\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af20b23d-307d-4a5f-9b54-3abd80e761bf", "name": "Validation or business rule failure", "originalRequest": { "url": { "path": [ "form-templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Category id (24-character hex string).", "type": "text/plain" }, "key": "categoryId", "value": "" }, { "disabled": false, "description": { "content": "Maximum templates to return; `0` means no limit.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ccf3c0e-8ad1-42d7-ba5e-7018a9773f26", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "form-templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Category id (24-character hex string).", "type": "text/plain" }, "key": "categoryId", "value": "" }, { "disabled": false, "description": { "content": "Maximum templates to return; `0` means no limit.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cfe980f8-cbef-4e42-bf98-d7de6adf7ca7", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "form-templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Category id (24-character hex string).", "type": "text/plain" }, "key": "categoryId", "value": "" }, { "disabled": false, "description": { "content": "Maximum templates to return; `0` means no limit.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0b41f62a-2173-4d9c-8f0b-8279a382262f", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "form-templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Category id (24-character hex string).", "type": "text/plain" }, "key": "categoryId", "value": "" }, { "disabled": false, "description": { "content": "Maximum templates to return; `0` means no limit.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29943444-ba24-48e5-9a88-39ab5c71617e", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "form-templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Category id (24-character hex string).", "type": "text/plain" }, "key": "categoryId", "value": "" }, { "disabled": false, "description": { "content": "Maximum templates to return; `0` means no limit.", "type": "text/plain" }, "key": "limit", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "favorites", "description": "", "item": [ { "id": "f9ca802a-d44b-4e27-bea2-2f0978913d64", "name": "List favorite templates", "request": { "name": "List favorite templates", "description": { "content": "Returns favorite template ids, or full list items when `data=1`.", "type": "text/plain" }, "url": { "path": [ "form-templates", "favorites" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When `1`, include template metadata (same shape as list). Otherwise returns an array of template ids in `data`. (This can only be one of 0,1)", "type": "text/plain" }, "key": "data", "value": "1" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2b421a6b-4338-4854-9d52-be9ce04b04c5", "name": "Favorites", "originalRequest": { "url": { "path": [ "form-templates", "favorites" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When `1`, include template metadata (same shape as list). Otherwise returns an array of template ids in `data`. (This can only be one of 0,1)", "type": "text/plain" }, "key": "data", "value": "1" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": [\n {\n \"title\": \"\",\n \"description\": \"\",\n \"categoryId\": \"\",\n \"categoryName\": \"\",\n \"form\": {\n \"previewImage\": {\n \"fileUrl\": \"\",\n \"fileId\": \"\"\n }\n },\n \"id\": \"\"\n },\n {\n \"title\": \"\",\n \"description\": \"\",\n \"categoryId\": \"\",\n \"categoryName\": \"\",\n \"form\": {\n \"previewImage\": {\n \"fileUrl\": \"\",\n \"fileId\": \"\"\n }\n },\n \"id\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe680a24-c354-46b8-be9c-12593180e070", "name": "Validation or business rule failure", "originalRequest": { "url": { "path": [ "form-templates", "favorites" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When `1`, include template metadata (same shape as list). Otherwise returns an array of template ids in `data`. (This can only be one of 0,1)", "type": "text/plain" }, "key": "data", "value": "1" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "96985327-558f-44b5-af98-84b8db1451fe", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "form-templates", "favorites" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When `1`, include template metadata (same shape as list). Otherwise returns an array of template ids in `data`. (This can only be one of 0,1)", "type": "text/plain" }, "key": "data", "value": "1" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7591eebb-59ee-40c7-86ee-f777889f0145", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "form-templates", "favorites" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When `1`, include template metadata (same shape as list). Otherwise returns an array of template ids in `data`. (This can only be one of 0,1)", "type": "text/plain" }, "key": "data", "value": "1" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1a7a5093-0542-401d-970d-48108e969173", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "form-templates", "favorites" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When `1`, include template metadata (same shape as list). Otherwise returns an array of template ids in `data`. (This can only be one of 0,1)", "type": "text/plain" }, "key": "data", "value": "1" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a9017d2-1622-4e38-b3ee-e407d2945eea", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "form-templates", "favorites" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When `1`, include template metadata (same shape as list). Otherwise returns an array of template ids in `data`. (This can only be one of 0,1)", "type": "text/plain" }, "key": "data", "value": "1" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "mine", "description": "", "item": [ { "id": "fdf8cf60-77d8-4578-92de-1b6d1a9a5997", "name": "List templates created by the caller", "request": { "name": "List templates created by the caller", "description": { "content": "Templates owned by the account tied to the API key (preview metadata per item).", "type": "text/plain" }, "url": { "path": [ "form-templates", "mine" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "69ab2fae-3494-458e-8daf-7e1287052939", "name": "Owned templates", "originalRequest": { "url": { "path": [ "form-templates", "mine" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": [\n {\n \"title\": \"\",\n \"description\": \"\",\n \"categoryId\": \"\",\n \"categoryName\": \"\",\n \"form\": {\n \"previewImage\": {\n \"fileUrl\": \"\",\n \"fileId\": \"\"\n }\n },\n \"id\": \"\"\n },\n {\n \"title\": \"\",\n \"description\": \"\",\n \"categoryId\": \"\",\n \"categoryName\": \"\",\n \"form\": {\n \"previewImage\": {\n \"fileUrl\": \"\",\n \"fileId\": \"\"\n }\n },\n \"id\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea9b0217-9a0e-4e45-b83d-e1a9e449e559", "name": "Validation or business rule failure", "originalRequest": { "url": { "path": [ "form-templates", "mine" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4a9e71b-0ac0-4657-97d3-c87bb66dbc51", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "form-templates", "mine" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7fcb75f-73cb-445c-a065-e007e2b601eb", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "form-templates", "mine" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47db5ccd-58f9-4662-bd1f-65b9130c3eee", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "form-templates", "mine" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e64419a7-2e09-4178-a5c4-c216bb1cc13d", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "form-templates", "mine" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "categories", "description": "", "item": [ { "id": "a48c59cf-d4d9-4062-ac09-bf62de622c8c", "name": "List template categories", "request": { "name": "List template categories", "description": { "content": "Returns all categories. Pass `items=1` to embed up to six public templates per root category (cached).", "type": "text/plain" }, "url": { "path": [ "form-templates", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When `1`, include `formTemplates` on root categories. (This can only be one of 0,1)", "type": "text/plain" }, "key": "items", "value": "1" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d28fb66e-23e0-4229-ba77-056ff32f10f2", "name": "Categories", "originalRequest": { "url": { "path": [ "form-templates", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When `1`, include `formTemplates` on root categories. (This can only be one of 0,1)", "type": "text/plain" }, "key": "items", "value": "1" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"parentId\": \"\",\n \"h1\": \"\",\n \"metaTitle\": \"\",\n \"metaDescription\": \"\",\n \"formTemplates\": [\n {\n \"title\": \"\",\n \"description\": \"\",\n \"categoryId\": \"\",\n \"categoryName\": \"\",\n \"form\": {\n \"previewImage\": {\n \"fileUrl\": \"\",\n \"fileId\": \"\"\n }\n },\n \"id\": \"\"\n },\n {\n \"title\": \"\",\n \"description\": \"\",\n \"categoryId\": \"\",\n \"categoryName\": \"\",\n \"form\": {\n \"previewImage\": {\n \"fileUrl\": \"\",\n \"fileId\": \"\"\n }\n },\n \"id\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"parentId\": \"\",\n \"h1\": \"\",\n \"metaTitle\": \"\",\n \"metaDescription\": \"\",\n \"formTemplates\": [\n {\n \"title\": \"\",\n \"description\": \"\",\n \"categoryId\": \"\",\n \"categoryName\": \"\",\n \"form\": {\n \"previewImage\": {\n \"fileUrl\": \"\",\n \"fileId\": \"\"\n }\n },\n \"id\": \"\"\n },\n {\n \"title\": \"\",\n \"description\": \"\",\n \"categoryId\": \"\",\n \"categoryName\": \"\",\n \"form\": {\n \"previewImage\": {\n \"fileUrl\": \"\",\n \"fileId\": \"\"\n }\n },\n \"id\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dde3f02e-189a-44d4-8936-50c56f6cd981", "name": "Validation or business rule failure", "originalRequest": { "url": { "path": [ "form-templates", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When `1`, include `formTemplates` on root categories. (This can only be one of 0,1)", "type": "text/plain" }, "key": "items", "value": "1" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c8e7a65-0ae2-49cf-abe1-600fc74e7fe1", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "form-templates", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When `1`, include `formTemplates` on root categories. (This can only be one of 0,1)", "type": "text/plain" }, "key": "items", "value": "1" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1aa197c-c89b-43e0-9bf8-033e92e53dd4", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "form-templates", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When `1`, include `formTemplates` on root categories. (This can only be one of 0,1)", "type": "text/plain" }, "key": "items", "value": "1" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e546b39-35ca-406d-9f2a-3f63d9729795", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "form-templates", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When `1`, include `formTemplates` on root categories. (This can only be one of 0,1)", "type": "text/plain" }, "key": "items", "value": "1" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "870aad48-2912-463e-bc84-2018392bd98d", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "form-templates", "categories" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "When `1`, include `formTemplates` on root categories. (This can only be one of 0,1)", "type": "text/plain" }, "key": "items", "value": "1" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "{templateId}", "description": "", "item": [ { "id": "0bc63363-3ee0-49fb-b24b-267515ce4898", "name": "Get template by id", "request": { "name": "Get template by id", "description": { "content": "Full template metadata. To create a live form: `GET .../form-create` → `POST /forms`. Guide: [Form Templates API](https://docs.form-qr-code-generator.com/v1/index.htm#form-templates-api).", "type": "text/plain" }, "url": { "path": [ "form-templates", ":templateId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "templateId", "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "870b4399-f94a-4f3d-90e4-0b448259a257", "name": "Template detail", "originalRequest": { "url": { "path": [ "form-templates", ":templateId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" }, "type": "any", "value": "", "key": "templateId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"title\": \"\",\n \"description\": \"\",\n \"categoryId\": \"\",\n \"categoryName\": \"\",\n \"form\": {\n \"previewImage\": {\n \"fileUrl\": \"\",\n \"fileId\": \"\"\n },\n \"key_0\": \"string\"\n },\n \"id\": \"\",\n \"metaTitle\": \"\",\n \"metaDescription\": \"\",\n \"h1\": \"\",\n \"isNew\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "59bac994-a7cd-4d2c-bc78-7943953f10ca", "name": "Validation or business rule failure", "originalRequest": { "url": { "path": [ "form-templates", ":templateId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" }, "type": "any", "value": "", "key": "templateId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "08514aad-5246-4c80-9c13-99018abe0029", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "form-templates", ":templateId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" }, "type": "any", "value": "", "key": "templateId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed08d38f-07f8-4e00-836b-84cf620ba293", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "form-templates", ":templateId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" }, "type": "any", "value": "", "key": "templateId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66837b10-aee4-4b18-871d-ecb117e3ef52", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "form-templates", ":templateId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" }, "type": "any", "value": "", "key": "templateId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "542446f1-d786-426f-85d1-4331a962f1a4", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "form-templates", ":templateId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" }, "type": "any", "value": "", "key": "templateId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "form-create", "description": "", "item": [ { "id": "84b32d3a-b49c-44fa-870b-871d74238f1a", "name": "Convert template to POST /forms body", "request": { "name": "Convert template to POST /forms body", "description": { "content": "Returns `POST /forms` body from template id. Use hex `id`, not URL slug. Guide: [Form Templates API](https://docs.form-qr-code-generator.com/v1/index.htm#form-templates-api).", "type": "text/plain" }, "url": { "path": [ "form-templates", ":templateId", "form-create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "templateId", "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0b4835f9-c9bf-4c19-93ab-1c171256bfbf", "name": "Form create body derived from the template", "originalRequest": { "url": { "path": [ "form-templates", ":templateId", "form-create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" }, "type": "any", "value": "", "key": "templateId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"title\": \"\",\n \"shortText\": \"\",\n \"fields\": [\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n },\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n }\n ],\n \"backgroundType\": \"solid\",\n \"backgroundColor1\": \"0076d7\",\n \"backgroundColor2\": \"3a74c5\",\n \"appearance\": {\n \"headerColor\": \"ffffff\",\n \"buttonColor\": \"ffffff\"\n },\n \"logo\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backgroundImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"backdrop\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"previewImage\": {\n \"fileId\": \"\",\n \"fileUrl\": \"\"\n },\n \"qrConfig\": {\n \"backgroundColor\": \"\",\n \"colorDark\": \"\",\n \"eye_inner\": \"eyeInner5\",\n \"eye_outer\": \"eyeOuter1\",\n \"logo\": \"\",\n \"qrCategory\": \"\",\n \"qrData\": \"pattern4\",\n \"size\": \"\",\n \"transparentBkg\": \"\",\n \"gradient\": \"\",\n \"grdType\": \"linear\",\n \"color01\": \"\",\n \"color02\": \"\",\n \"eye_color\": \"\",\n \"eye_color01\": \"\",\n \"eye_color02\": \"\",\n \"frame\": 13,\n \"frameText\": \"\",\n \"frameTextFont\": \"Oswald\",\n \"frameColor\": \"\",\n \"frameColor2\": \"\",\n \"frameColorType\": \"downUp\",\n \"frameGradientStartColor\": \"\",\n \"frameGradientEndColor\": \"\"\n },\n \"isQuiz\": false,\n \"quizConfig\": {\n \"passingScore\": 70,\n \"distributeMarksEvenly\": \"\",\n \"enableTimeLimit\": \"\",\n \"timeLimit\": 1800,\n \"shuffleQuestions\": \"\",\n \"showFinalScore\": \"\",\n \"showAnswersResults\": \"\",\n \"stepByStep\": \"\",\n \"passMessage\": \"\",\n \"failMessage\": \"\",\n \"timeUpMessage\": \"\"\n },\n \"submissionNotification\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "846dfd42-aa37-4cfc-ba3e-a3237d65651d", "name": "Invalid template id or template not found", "originalRequest": { "url": { "path": [ "form-templates", ":templateId", "form-create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" }, "type": "any", "value": "", "key": "templateId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3c482c71-f8ae-4717-bc7b-4708b99dd97b", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "form-templates", ":templateId", "form-create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" }, "type": "any", "value": "", "key": "templateId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "844efa84-9a7d-42d0-8eb2-bf19c6921062", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "form-templates", ":templateId", "form-create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" }, "type": "any", "value": "", "key": "templateId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7cbe2b0-a6de-47bd-90a9-778e3f328151", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "form-templates", ":templateId", "form-create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" }, "type": "any", "value": "", "key": "templateId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "25364680-08f3-4b50-887b-5438c0c1fe20", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "form-templates", ":templateId", "form-create" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" }, "type": "any", "value": "", "key": "templateId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "share", "description": "", "item": [ { "id": "cd4ef147-2162-4650-bc1c-b8eb5c1e8205", "name": "Email a template link", "request": { "name": "Email a template link", "description": { "content": "Emails a template gallery link to up to five comma-separated addresses. Provide `fromName` when the caller has no display name on the account.", "type": "text/plain" }, "url": { "path": [ "form-templates", ":templateId", "share" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "templateId", "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"recipients\": \"\",\n \"fromName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "391bca2b-5d3e-4d53-8bf9-7c9bae2ca539", "name": "Share email queued or sent", "originalRequest": { "url": { "path": [ "form-templates", ":templateId", "share" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" }, "type": "any", "value": "", "key": "templateId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"recipients\": \"\",\n \"fromName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c41f4e0-0d0d-4cef-8db7-aa3f8e9cfc67", "name": "Validation or business rule failure", "originalRequest": { "url": { "path": [ "form-templates", ":templateId", "share" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" }, "type": "any", "value": "", "key": "templateId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"recipients\": \"\",\n \"fromName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe13d52d-eb23-42f1-a446-018e7b8c0c28", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "form-templates", ":templateId", "share" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" }, "type": "any", "value": "", "key": "templateId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"recipients\": \"\",\n \"fromName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "053f0817-0354-4a6c-a2ed-f4c7ae5e540e", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "form-templates", ":templateId", "share" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" }, "type": "any", "value": "", "key": "templateId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"recipients\": \"\",\n \"fromName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5034d292-c811-4751-8cf9-3fecc077bd7c", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "form-templates", ":templateId", "share" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" }, "type": "any", "value": "", "key": "templateId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"recipients\": \"\",\n \"fromName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "258e7d1a-e6c4-4d12-b8fc-4aeec25505d5", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "form-templates", ":templateId", "share" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" }, "type": "any", "value": "", "key": "templateId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"recipients\": \"\",\n \"fromName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "favorite", "description": "", "item": [ { "id": "8d28c3f2-644f-47d6-a2f9-6dabae3c352c", "name": "Add template to favorites", "request": { "name": "Add template to favorites", "description": { "content": "Adds a public template to your account favorites. Use template **id** from list responses.", "type": "text/plain" }, "url": { "path": [ "form-templates", ":templateId", "favorite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "templateId", "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b6c7d947-2614-4376-baaf-86b7d96b3952", "name": "Favorite updated", "originalRequest": { "url": { "path": [ "form-templates", ":templateId", "favorite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" }, "type": "any", "value": "", "key": "templateId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"key_0\": \"string\",\n \"key_1\": 7511\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "14bd7bb7-4eab-44ea-bb76-390396735a59", "name": "Validation or business rule failure", "originalRequest": { "url": { "path": [ "form-templates", ":templateId", "favorite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" }, "type": "any", "value": "", "key": "templateId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73bf9b5c-bffc-4a1b-bea0-379857a265a4", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "form-templates", ":templateId", "favorite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" }, "type": "any", "value": "", "key": "templateId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95366bb2-0f9e-40ec-a2ae-a37408a17817", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "form-templates", ":templateId", "favorite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" }, "type": "any", "value": "", "key": "templateId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98b90dac-91ac-4465-ac95-1034b837a2d7", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "form-templates", ":templateId", "favorite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" }, "type": "any", "value": "", "key": "templateId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbe7a563-94de-4f5d-aedb-a55e125b2fe9", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "form-templates", ":templateId", "favorite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" }, "type": "any", "value": "", "key": "templateId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "547ada7c-c518-44d4-877f-922306d2e25c", "name": "Remove template from favorites", "request": { "name": "Remove template from favorites", "description": { "content": "Removes a template from your account favorites. Use template **id** from list responses.", "type": "text/plain" }, "url": { "path": [ "form-templates", ":templateId", "favorite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "templateId", "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0527489a-3277-4ea7-aa90-707bea9cff89", "name": "Favorite updated", "originalRequest": { "url": { "path": [ "form-templates", ":templateId", "favorite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" }, "type": "any", "value": "", "key": "templateId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"key_0\": \"string\",\n \"key_1\": 7511\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4823c90f-8ed7-4d68-91b9-a2d7ed2e7033", "name": "Validation or business rule failure", "originalRequest": { "url": { "path": [ "form-templates", ":templateId", "favorite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" }, "type": "any", "value": "", "key": "templateId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "21e62302-b6ff-456f-9bf1-ff20b6b815dc", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "form-templates", ":templateId", "favorite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" }, "type": "any", "value": "", "key": "templateId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd563663-5170-4f73-919d-ffaca22ac2ff", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "form-templates", ":templateId", "favorite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" }, "type": "any", "value": "", "key": "templateId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2e0ec018-518c-4dda-8194-5559eafd61e1", "name": "Monthly API request limit reached (enforced as `apiLimit`)", "originalRequest": { "url": { "path": [ "form-templates", ":templateId", "favorite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" }, "type": "any", "value": "", "key": "templateId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e83a746e-7baf-4eef-86e6-137386950742", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "form-templates", ":templateId", "favorite" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Template id (24-character hex string from list responses).", "type": "text/plain" }, "type": "any", "value": "", "key": "templateId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "qr-design-templates", "description": "", "item": [ { "id": "2d7731d8-2b88-482b-8cf3-2c145f787979", "name": "List QR design presets", "request": { "name": "List QR design presets", "description": { "content": "Built-in QR styling presets — copy `config` into `qrConfig`. Guide: [Built-in QR Design Presets](https://docs.form-qr-code-generator.com/v1/index.htm#qr-design-templates-api).", "type": "text/plain" }, "url": { "path": [ "qr-design-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "66248cdb-eb08-4662-b5dd-e38cab3c9ce8", "name": "Preset list", "originalRequest": { "url": { "path": [ "qr-design-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": [\n {\n \"id\": \"\",\n \"previewUrl\": \"\",\n \"config\": {\n \"backgroundColor\": \"\",\n \"colorDark\": \"\",\n \"eye_inner\": \"eyeInner0\",\n \"eye_outer\": \"eyeOuter9\",\n \"logo\": \"\",\n \"qrCategory\": \"\",\n \"qrData\": \"pattern4\",\n \"size\": \"\",\n \"transparentBkg\": \"\",\n \"gradient\": \"\",\n \"grdType\": \"diagonal2\",\n \"color01\": \"\",\n \"color02\": \"\",\n \"eye_color\": \"\",\n \"eye_color01\": \"\",\n \"eye_color02\": \"\",\n \"frame\": 14,\n \"frameText\": \"\",\n \"frameTextFont\": \"Lato\",\n \"frameColor\": \"\",\n \"frameColor2\": \"\",\n \"frameColorType\": \"fill\",\n \"frameGradientStartColor\": \"\",\n \"frameGradientEndColor\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"previewUrl\": \"\",\n \"config\": {\n \"backgroundColor\": \"\",\n \"colorDark\": \"\",\n \"eye_inner\": \"eyeInner5\",\n \"eye_outer\": \"eyeOuter1\",\n \"logo\": \"\",\n \"qrCategory\": \"\",\n \"qrData\": \"pattern14\",\n \"size\": \"\",\n \"transparentBkg\": \"\",\n \"gradient\": \"\",\n \"grdType\": \"radial\",\n \"color01\": \"\",\n \"color02\": \"\",\n \"eye_color\": \"\",\n \"eye_color01\": \"\",\n \"eye_color02\": \"\",\n \"frame\": 15,\n \"frameText\": \"\",\n \"frameTextFont\": \"Helvetica\",\n \"frameColor\": \"\",\n \"frameColor2\": \"\",\n \"frameColorType\": \"fill\",\n \"frameGradientStartColor\": \"\",\n \"frameGradientEndColor\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5f62ae92-8253-4b3c-9900-3187e513ca72", "name": "Validation or business rule failure", "originalRequest": { "url": { "path": [ "qr-design-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aeae8596-3e21-44a2-8525-e9cd69d50c96", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "qr-design-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6970223c-86ef-48c6-8957-cfaf4055dc54", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "qr-design-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6732d040-1814-4e8f-9ca5-34472f4a3b40", "name": "Monthly API quota exceeded", "originalRequest": { "url": { "path": [ "qr-design-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c7d40b41-586a-4023-94ba-8b3a77dd39b4", "name": "Unexpected server error on a documented route (normalized JSON body).", "originalRequest": { "url": { "path": [ "qr-design-templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "form-ai-builder", "description": "", "item": [ { "name": "generate", "description": "", "item": [ { "id": "485f0249-64d8-4d7c-93af-ba68e80c4b6b", "name": "Generate form draft from prompt", "request": { "name": "Generate form draft from prompt", "description": { "content": "Draft form layout from natural-language prompt. Review output, then POST /forms. Guide: [AI Form Builder](https://docs.form-qr-code-generator.com/v1/index.htm#ai-form-builder-api).", "type": "text/plain" }, "url": { "path": [ "form-ai-builder", "generate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"prompt\": \"\",\n \"currentForm\": {\n \"title\": \"\",\n \"shortText\": \"\",\n \"locale\": \"\",\n \"fields\": [\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n },\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0ccc13f8-bfde-4ea0-a740-cee1559b6be4", "name": "Generated form draft", "originalRequest": { "url": { "path": [ "form-ai-builder", "generate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"prompt\": \"\",\n \"currentForm\": {\n \"title\": \"\",\n \"shortText\": \"\",\n \"locale\": \"\",\n \"fields\": [\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n },\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\",\n \"data\": {\n \"title\": \"\",\n \"shortText\": \"\",\n \"locale\": \"\",\n \"isQuiz\": \"\",\n \"fields\": [\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n },\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f72e73e-54b6-4000-8b61-67380f0d50c6", "name": "Missing or too-short prompt, or invalid AI response", "originalRequest": { "url": { "path": [ "form-ai-builder", "generate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"prompt\": \"\",\n \"currentForm\": {\n \"title\": \"\",\n \"shortText\": \"\",\n \"locale\": \"\",\n \"fields\": [\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n },\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 863.5022219680421\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc97ba3c-e428-4683-89a1-acf93d844796", "name": "Missing or invalid API key", "originalRequest": { "url": { "path": [ "form-ai-builder", "generate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"prompt\": \"\",\n \"currentForm\": {\n \"title\": \"\",\n \"shortText\": \"\",\n \"locale\": \"\",\n \"fields\": [\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n },\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": false,\n \"key_1\": \"string\",\n \"key_2\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "494caf45-c8d2-405f-9f45-164f7fa89959", "name": "Undocumented path or method. Wrong qrId on a valid route usually returns **400**, not 404 — see [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).", "originalRequest": { "url": { "path": [ "form-ai-builder", "generate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"prompt\": \"\",\n \"currentForm\": {\n \"title\": \"\",\n \"shortText\": \"\",\n \"locale\": \"\",\n \"fields\": [\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n },\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7c47c8b-9779-45f4-ade1-b6cfc18bb4c4", "name": "Monthly API quota exceeded", "originalRequest": { "url": { "path": [ "form-ai-builder", "generate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"prompt\": \"\",\n \"currentForm\": {\n \"title\": \"\",\n \"shortText\": \"\",\n \"locale\": \"\",\n \"fields\": [\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n },\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": 2909.858078489005,\n \"key_1\": false\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3231899f-4361-4a6b-a10a-11525a24c397", "name": "AI service or server error", "originalRequest": { "url": { "path": [ "form-ai-builder", "generate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"prompt\": \"\",\n \"currentForm\": {\n \"title\": \"\",\n \"shortText\": \"\",\n \"locale\": \"\",\n \"fields\": [\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n },\n {\n \"type\": \"name\",\n \"option\": {\n \"label\": \"\",\n \"required\": false,\n \"hint\": \"\"\n }\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"failed\",\n \"message\": \"\",\n \"code\": \"\",\n \"data\": {\n \"key_0\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.form-qr-code-generator.com/v1" } ], "info": { "_postman_id": "b20091bf-eb39-420f-ac90-2d6bc37046a4", "name": "TIGER FORM API Documentation", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Public HTTP API for TIGER FORM — create forms, send or read submissions, download QR images, webhooks, and analytics.\n\n**New integrator?** [Getting Started](https://docs.form-qr-code-generator.com/v1/index.htm#getting-started) → [End-to-End Integration](https://docs.form-qr-code-generator.com/v1/index.htm#end-to-end-integration) (5 copy-paste steps).\n\n**Base URL:** `https://api.form-qr-code-generator.com/v1`\n\n**Authentication:** `Authorization: Bearer ` on every documented route.\n\n**JSON responses:** Success `{ \"status\": \"success\", \"data\": ... }`. Errors `{ \"status\": \"failed\", \"message\", \"code\", \"data\": {} }` (400, 401, 403, 404, 409, 429, 500). Exception: **`GET /forms/{qrId}/download`** returns a binary file, not JSON.\n\n**Typical submission flow:** (1) **`GET /forms/{qrId}/submission-schema`** for field keys, (2) optional **`POST /forms/{qrId}/uploads`** (`category=submission`) for files, (3) **`POST /forms/{qrId}/submissions`** with top-level **`answers`**. Optional **`Idempotency-Key`** on create. See [Create a Submission](https://docs.form-qr-code-generator.com/v1/index.htm#create-submission) and [Upload APIs Compared](https://docs.form-qr-code-generator.com/v1/index.htm#upload-apis-compared).\n\n**Plans & quota:** Each v1 request counts toward your account **monthly API request limit** (reference: Freemium **500**, Starter **10,000**, Business **30,000**, Professional **50,000** per month; **Enterprise** — [Contact us](https://www.form-qr-code-generator.com/contact-us) or tiger-form@qrtiger.helpscoutapp.com — [Rate Limits & Retries](https://docs.form-qr-code-generator.com/v1/index.htm#rate-limits)). Limit reached → HTTP **429**. Expired or cancelled paid subscriptions are **not** downgraded to Freemium — inactive subscription → **400** on most operations after the quota gate; renew to restore access. HTTP **429** means the monthly API request limit is exhausted (separate from inactive subscription). See [Rate Limits & Retries](https://docs.form-qr-code-generator.com/v1/index.htm#rate-limits) and [Error Model](https://docs.form-qr-code-generator.com/v1/index.htm#error-model).\n\n**More guides:** [Core Concepts](https://docs.form-qr-code-generator.com/v1/index.htm#core-concepts), [SDK Examples](https://docs.form-qr-code-generator.com/v1/index.htm#sdk-examples), [Webhooks](https://docs.form-qr-code-generator.com/v1/index.htm#webhook-api), [Versioning](https://docs.form-qr-code-generator.com/v1/index.htm#versioning). [Status](https://docs.form-qr-code-generator.com/v1/status.html) · [SLA](https://docs.form-qr-code-generator.com/v1/sla.html) · Support: tiger-form@qrtiger.helpscoutapp.com\n\nContact Support:\n Name: TIGER FORM API Support\n Email: tiger-form@qrtiger.helpscoutapp.com", "type": "text/plain" } } }