{"items":[{"type":"link","label":"forms.app API","link":"/apis","routeSlug":"/apis","content":{"contentType":"overview","meta":{"name":"forms.app API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"index.json","url":"/_bundle/apis/index.json?download"},{"kind":"download","label":"index.yaml","url":"/_bundle/apis/index.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Proprietary","url":"https://forms.app/terms"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.forms.app"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"forms.app API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/apis"}],"sectionId":"/apis"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/overview"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"forms.app API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" gives you programmatic, read-only access to your forms and their"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"submissions. You can list all the forms in your account, fetch a specific form's complete"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"structure (questions, design settings, submission behaviour, thank-you pages), and page"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"through the answers your respondents have submitted."},"children":[]}]}]}]}],"sectionId":"/apis/section/overview"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every request must be authenticated with exactly "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the two methods below."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Providing both in the same request is not allowed and will return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401 Unauthorized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/apis/section/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/option-1-oauth-2.0-bearer-token"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Option 1 — OAuth 2.0 Bearer Token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Obtain a JWT via the forms.app OAuth 2.0 flow and pass it in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Bearer <your_token>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Bearer <your_token>\n"},"children":[]}]}]}],"sectionId":"/apis/section/option-1-oauth-2.0-bearer-token"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/option-2-api-key"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Option 2 — API Key"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass your API key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-Api-Key: <your_api_key>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-Api-Key: <your_api_key>\n"},"children":[]}]}]}],"sectionId":"/apis/section/option-2-api-key"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"section/how-to-create-an-api-key"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How to create an API key"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://forms.app"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"forms.app"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Click your avatar in the top-right corner and open "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Go to the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tab."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create API Key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", enter a descriptive name, and confirm."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Copy the generated key immediately — it is shown "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only once"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Store it securely (e.g. in an environment variable or secret manager)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can create multiple keys (one per integration), and revoke any of them at any time"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from the same "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" settings page."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Newly created or re-activated keys:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for up to ~30 seconds, a key whose validation"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"recently failed may keep returning "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401 Unauthorized"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from a short-lived cache. If a key"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"you just created or re-activated is rejected, wait ~30 seconds and retry."},"children":[]}]}]}]}]}],"sectionId":"/apis/section/how-to-create-an-api-key"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/response-envelope"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response Envelope"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All endpoints return a consistent JSON envelope:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"success\": true,\n  \"data\": { },\n  \"errors\": []\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"success\": true,\n  \"data\": { },\n  \"errors\": []\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"4xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5xx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n  \"success\": false,\n  \"data\": null,\n  \"errors\": [\n    { \"errorCode\": 1001, \"errorMessage\": \"Unauthorized\" }\n  ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n  \"success\": false,\n  \"data\": null,\n  \"errors\": [\n    { \"errorCode\": 1001, \"errorMessage\": \"Unauthorized\" }\n  ]\n}\n"},"children":[]}]}]}],"sectionId":"/apis/section/response-envelope"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/rate-limiting"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate Limiting"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests are rate-limited per API key / token (falling back to client IP when neither is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"present). You may send up to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"300 requests per 60-second window"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When the limit is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exceeded the API returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429 Too Many Requests"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header indicating how"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"many seconds to wait before the window resets. Wait for that period and retry — do not spam"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the endpoint in a tight loop."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A short-term burst limit also applies per endpoint (about "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"50 requests per second"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", with a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"burst allowance up to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"100"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Spread requests out rather than firing them in a tight burst"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to avoid transient "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" responses."},"children":[]}]}]}]}],"sectionId":"/apis/section/rate-limiting"}]}]}},{"type":"link","label":"Overview","link":"/apis/section/overview","routeSlug":"/apis/section/overview","content":null},{"type":"link","label":"Authentication","link":"/apis/section/authentication","routeSlug":"/apis/section/authentication","content":null},{"type":"link","label":"Option 1 — OAuth 2.0 Bearer Token","link":"/apis/section/option-1-oauth-2.0-bearer-token","routeSlug":"/apis/section/option-1-oauth-2.0-bearer-token","content":null},{"type":"link","label":"Option 2 — API Key","link":"/apis/section/option-2-api-key","routeSlug":"/apis/section/option-2-api-key","content":null},{"type":"link","label":"How to create an API key","link":"/apis/section/how-to-create-an-api-key","routeSlug":"/apis/section/how-to-create-an-api-key","content":null},{"type":"link","label":"Response Envelope","link":"/apis/section/response-envelope","routeSlug":"/apis/section/response-envelope","content":null},{"type":"link","label":"Rate Limiting","link":"/apis/section/rate-limiting","routeSlug":"/apis/section/rate-limiting","content":null},{"type":"group","label":"Form","link":"/apis/form","routeSlug":"/apis/form","items":[{"label":"List all forms","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/form/getuserforms","routeSlug":"/apis/form/getuserforms","metadata":{"seo":{"title":"List all forms","description":"Returns a list of all forms that belong to the authenticated account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUserForms","name":"List all forms","isWebhook":false,"pointer":"/paths/~1v1~1form/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all forms","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of all forms that belong to the authenticated account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each item in the returned array contains the form's unique identifier ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and its"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"title. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /form/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to retrieve the full structure of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a specific form including questions, design, and settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forms are returned regardless of their visibility state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"public"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unlisted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"private"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") as long as they belong to the authenticated user and are not in the trash"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or archived."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth 2.0 Bearer token (HS256 JWT) issued by the forms.app OAuth 2.0 flow."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass the token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Bearer <your_token>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Bearer <your_token>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cannot be combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — use one or the other per request."},"children":[]}]}]}]}]},{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key generated from your forms.app account settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass the key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-Api-Key: <your_api_key>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-Api-Key: <your_api_key>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How to create an API key:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://forms.app"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"forms.app"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create API Key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", give it a name, and copy the key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key is shown "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only once"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — store it securely."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cannot be combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — use one or the other per request."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/form","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.forms.app"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","429","500"],"pointer":"/v1/form","href":"form/getuserforms","openApiOperationId":"getUserForms","summary":"List all forms","securityGroups":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.forms.app"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of forms returned successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_6"}},"schemaId":"schema_6"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400 Bad Request"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The request is malformed or contains invalid parameters."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array for details on which field or value is invalid."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorWrapper"}},"schemaId":"components/schemas/ErrorWrapper"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401 Unauthorized"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The request is missing authentication, the provided token or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key is invalid / expired, or both authentication methods were supplied simultaneously."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ensure you are passing exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key: <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorWrapper"}},"schemaId":"components/schemas/ErrorWrapper"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"429 Too Many Requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The rate limit for this API key or token has been exceeded."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Back off and retry after a short delay. Avoid retrying in a tight loop."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorWrapper"}},"schemaId":"components/schemas/ErrorWrapper"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500 Internal Server Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — An unexpected error occurred on the server."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is not caused by the request itself. If the problem persists, contact support."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorWrapper"}},"schemaId":"components/schemas/ErrorWrapper"}],"pointer":"/paths/~1v1~1form/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_6","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_6"}}},{"code":"400","schemaId":"components/schemas/ErrorWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorWrapper"}}},{"code":"429","schemaId":"components/schemas/ErrorWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorWrapper"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/form/getuserforms"}],"panels":[]}]},"httpPath":"/v1/form"},{"label":"Get form by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/form/getformbyid","routeSlug":"/apis/form/getformbyid","metadata":{"seo":{"title":"Get form by ID","description":"Returns the complete structure of a single form identified by its _id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFormById","name":"Get form by ID","isWebhook":false,"pointer":"/paths/~1v1~1form~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get form by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the complete structure of a single form identified by its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response includes everything needed to understand or reproduce the form:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"questions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — ordered list of all questions, each with its type ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"questionType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"label, description, required flag, and type-specific settings (choice options, text"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"constraints, file upload limits, etc.)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"baseSettings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — behavioural settings: captcha, draft saving, multi-step navigation,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"multiple-submission prevention, and more."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"designSettings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — visual theme: colours (background, question, answer, border, main),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"font family and size, border radius, background image, and theme name."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"logo"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — logo image URL, alignment, brightness, and sticky behaviour."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"thankYouPages"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — one or more thank-you screens shown after submission, including"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"redirect configuration, sharing options, and statistics display."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"submitButton"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — label text and alignment of the submission button."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"state"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — visibility of the form: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"public"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"unlisted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"private"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supportedLanguages"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — language codes the form is available in."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"calculators / conditions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — scoring calculator rules and conditional logic (raw arrays)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"createDate / updateDate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — ISO 8601 timestamps of creation and last modification."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404 Not Found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the form does not exist or belongs to a different account."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth 2.0 Bearer token (HS256 JWT) issued by the forms.app OAuth 2.0 flow."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass the token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Bearer <your_token>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Bearer <your_token>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cannot be combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — use one or the other per request."},"children":[]}]}]}]}]},{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key generated from your forms.app account settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass the key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-Api-Key: <your_api_key>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-Api-Key: <your_api_key>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How to create an API key:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://forms.app"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"forms.app"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create API Key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", give it a name, and copy the key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key is shown "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only once"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — store it securely."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cannot be combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — use one or the other per request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of the form to retrieve."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1form~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/form/{id}","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.forms.app"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_7"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/form/{id}","href":"form/getformbyid","openApiOperationId":"getFormById","summary":"Get form by ID","securityGroups":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.forms.app"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Form returned successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_8"}},"schemaId":"schema_8"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400 Bad Request"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The request is malformed or contains invalid parameters."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array for details on which field or value is invalid."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorWrapper"}},"schemaId":"components/schemas/ErrorWrapper"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401 Unauthorized"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The request is missing authentication, the provided token or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key is invalid / expired, or both authentication methods were supplied simultaneously."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ensure you are passing exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key: <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorWrapper"}},"schemaId":"components/schemas/ErrorWrapper"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404 Not Found"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The requested resource does not exist, or belongs to a different"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"account and is not accessible with the current credentials."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorWrapper"}},"schemaId":"components/schemas/ErrorWrapper"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"429 Too Many Requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The rate limit for this API key or token has been exceeded."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Back off and retry after a short delay. Avoid retrying in a tight loop."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorWrapper"}},"schemaId":"components/schemas/ErrorWrapper"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500 Internal Server Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — An unexpected error occurred on the server."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is not caused by the request itself. If the problem persists, contact support."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorWrapper"}},"schemaId":"components/schemas/ErrorWrapper"}],"pointer":"/paths/~1v1~1form~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_8","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_8"}}},{"code":"400","schemaId":"components/schemas/ErrorWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorWrapper"}}},{"code":"429","schemaId":"components/schemas/ErrorWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorWrapper"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/form/getformbyid"}],"panels":[]}]},"httpPath":"/v1/form/{id}"}],"content":{"contentType":"group","meta":{"name":"Form"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Form","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read-only access to forms in your account. A form is the central resource — it contains"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an ordered list of questions (each with its own type, settings, and optional choices),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"visual design settings (colours, fonts, theme), behavioural settings (captcha, drafts,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"multi-page steps), logo configuration, and one or more thank-you pages shown after"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"submission. Use these endpoints to inspect form structure and sync it with external systems."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/form","summary":"List all forms","prefix":{"name":"get","color":"get"},"badges":[],"link":"/form/getuserforms","deprecated":false},{"title":"/v1/form/{id}","summary":"Get form by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/form/getformbyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Answer","link":"/apis/answer","routeSlug":"/apis/answer","items":[{"label":"List form answers (paginated)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/answer/listformanswersbypage","routeSlug":"/apis/answer/listformanswersbypage","metadata":{"seo":{"title":"List form answers (paginated)","description":"Returns one page of submitted answers for the specified form. Because a form canaccumulate a large number of submissions, results are delivered in pages."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listFormAnswersByPage","name":"List form answers (paginated)","isWebhook":false,"pointer":"/paths/~1v1~1form~1{id}~1answer~1p~1{pageNumber}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List form answers (paginated)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns one page of submitted answers for the specified form. Because a form can"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accumulate a large number of submissions, results are delivered in pages."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination flow:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageNumber: 1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the first page."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response contains "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalCount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (total number of submissions) and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"searchAfter"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cursor array that points to the last record in the current page."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Increment "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by 1 for each subsequent request. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"searchAfter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cursor"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in the response can be used for cursor-based navigation in advanced scenarios."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Repeat until you have fetched all pages (compare collected count against "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalCount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each answer object contains:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"answers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — array of per-question replies. Each entry uses short-hand field names:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"q"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (question ID), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"t"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (text), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"n"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (number), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"d"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (date), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"b"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (boolean),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (choice selections with text "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"t"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"v"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and order "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"o"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (name fields: first, last, middle, prefix, suffix),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"a"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (address fields: line 1, line 2, city, state, postal code, country),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"p"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (phone: country code, area, number, extension),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"f"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (uploaded files: file ID, type, size), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ac"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (answer comment)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"userInfo"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — optional respondent info (full name) if collected."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"point"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — total score ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") when the form uses a calculator / quiz scoring."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"answerFiles"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — metadata for files attached to the submission."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fileToken"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — token used to download file attachments."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"publicId"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — public-facing submission identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"createDate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — ISO 8601 timestamp of when the answer was submitted."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404 Not Found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the form does not exist or belongs to a different account."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth 2.0 Bearer token (HS256 JWT) issued by the forms.app OAuth 2.0 flow."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass the token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Bearer <your_token>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Bearer <your_token>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cannot be combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — use one or the other per request."},"children":[]}]}]}]}]},{"schemes":[{"name":"ApiKeyAuth","scopes":[],"type":"apiKey","in":"header","paramName":"X-Api-Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key generated from your forms.app account settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass the key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-Api-Key: <your_api_key>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-Api-Key: <your_api_key>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How to create an API key:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://forms.app"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"forms.app"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create API Key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", give it a name, and copy the key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key is shown "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only once"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — store it securely."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cannot be combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — use one or the other per request."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_7","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") of the form whose answers to retrieve."},"children":[]}]}]}],"required":true},{"name":"pageNumber","in":"path","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page number to retrieve. Starts at "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Increment by 1 for each subsequent page."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1form~1{id}~1answer~1p~1{pageNumber}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/form/{id}/answer/p/{pageNumber}","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.forms.app"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_7"},{"name":"pageNumber","in":"path","required":true,"schemaId":"schema_9"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]},{"schemes":[{"id":"ApiKeyAuth","type":"apiKey","name":"X-Api-Key","in":"header"}],"scopes":[]}],"responseCodes":["200","400","401","404","429","500"],"pointer":"/v1/form/{id}/answer/p/{pageNumber}","href":"answer/listformanswersbypage","openApiOperationId":"listFormAnswersByPage","summary":"List form answers (paginated)","securityGroups":[{"BearerAuth":[]},{"ApiKeyAuth":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.forms.app"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Answer page returned successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_10"}},"schemaId":"schema_10"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"400 Bad Request"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The request is malformed or contains invalid parameters."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array for details on which field or value is invalid."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorWrapper"}},"schemaId":"components/schemas/ErrorWrapper"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"401 Unauthorized"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The request is missing authentication, the provided token or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key is invalid / expired, or both authentication methods were supplied simultaneously."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ensure you are passing exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key: <key>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorWrapper"}},"schemaId":"components/schemas/ErrorWrapper"},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"404 Not Found"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The requested resource does not exist, or belongs to a different"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"account and is not accessible with the current credentials."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorWrapper"}},"schemaId":"components/schemas/ErrorWrapper"},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"429 Too Many Requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — The rate limit for this API key or token has been exceeded."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Back off and retry after a short delay. Avoid retrying in a tight loop."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorWrapper"}},"schemaId":"components/schemas/ErrorWrapper"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"500 Internal Server Error"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — An unexpected error occurred on the server."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is not caused by the request itself. If the problem persists, contact support."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorWrapper"}},"schemaId":"components/schemas/ErrorWrapper"}],"pointer":"/paths/~1v1~1form~1{id}~1answer~1p~1{pageNumber}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_10","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_10"}}},{"code":"400","schemaId":"components/schemas/ErrorWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorWrapper"}}},{"code":"401","schemaId":"components/schemas/ErrorWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorWrapper"}}},{"code":"404","schemaId":"components/schemas/ErrorWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorWrapper"}}},{"code":"429","schemaId":"components/schemas/ErrorWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorWrapper"}}},{"code":"500","schemaId":"components/schemas/ErrorWrapper","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorWrapper"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/answer/listformanswersbypage"}],"panels":[]}]},"httpPath":"/v1/form/{id}/answer/p/{pageNumber}"}],"content":{"contentType":"group","meta":{"name":"Answer"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Answer","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read submitted answers (responses) for a form. Because a form can accumulate thousands of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"submissions, answers are returned in pages. Each page contains a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"result"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array of answer"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"objects, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalCount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of all submissions, and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"searchAfter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cursor you pass as the next"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to continue walking through the full result set. Each answer captures the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"respondent's replies to every question, optional file attachments, user info, scoring points,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and submission metadata such as creation date."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/form/{id}/answer/p/{pageNumber}","summary":"List form answers (paginated)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/answer/listformanswersbypage","deprecated":false}]}]}]}]}},{"type":"group","label":"Gateway","link":"/apis/gateway","routeSlug":"/apis/gateway","items":[{"label":"Gateway health check","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/gateway/gatewayhealth","routeSlug":"/apis/gateway/gatewayhealth","metadata":{"seo":{"title":"Gateway health check","description":"Returns the operational status of the API gateway (KrakenD) itself.Use this endpoint for infrastructure liveness probes and uptime monitoring."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"gatewayHealth","name":"Gateway health check","isWebhook":false,"pointer":"/paths/~1v1~1health/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gateway health check","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the operational status of the API gateway (KrakenD) itself."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint for infrastructure liveness probes and uptime monitoring."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is a KrakenD built-in endpoint — it reflects the gateway process status,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not any upstream backend service. Authentication is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" required."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/health","servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.forms.app"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/v1/health","href":"gateway/gatewayhealth","openApiOperationId":"gatewayHealth","summary":"Gateway health check"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis","description":"Mock server","isMockServer":true},{"url":"https://api.forms.app"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The gateway is up and running.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_11","exampleIds":["paths/~1v1~1health/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_11","exampleIds":["paths/~1v1~1health/get/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1v1~1health/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_11","exampleIds":["paths/~1v1~1health/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_11","exampleIds":["paths/~1v1~1health/get/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gateway/gatewayhealth"}],"panels":[]}]},"httpPath":"/v1/health"}],"content":{"contentType":"group","meta":{"name":"Gateway"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gateway","showPageActions":true},{"nodeType":"markdoc","content":"Gateway-level operational endpoints. These reflect the health and status of the API\ngateway itself rather than any backend service. No authentication is required."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/health","summary":"Gateway health check","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gateway/gatewayhealth","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/SuccessWrapper":{"id":"components/schemas/SuccessWrapper","kind":"json-schema","title":"SuccessWrapper","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard envelope wrapping all successful responses. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field contains the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"actual payload and its shape varies per endpoint (object or array). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always an empty array on success."},"children":[]}]}]}],"type":"object","properties":{"success":{"type":"boolean","enum":[true],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for successful responses."},"children":[]}]}]}]},"data":{"description":"The response payload. Shape depends on the endpoint."},"errors":{"type":"array","items":{},"maxItems":0,"description":"Always an empty array on success."}}}},"components/schemas/FormListItem":{"id":"components/schemas/FormListItem","kind":"json-schema","title":"FormListItem","data":{"type":"object","properties":{"_id":{"type":"string"},"title":{"type":"string"}}}},"components/schemas/ApiError":{"id":"components/schemas/ApiError","kind":"json-schema","title":"ApiError","data":{"description":"A single error entry describing what went wrong.","type":"object","properties":{"errorCode":{"type":"integer","description":"Machine-readable error code identifying the specific failure reason."},"errorMessage":{"type":"string","description":"Human-readable description of the error."}}}},"components/schemas/ErrorWrapper":{"id":"components/schemas/ErrorWrapper","kind":"json-schema","title":"ErrorWrapper","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Standard envelope for all error responses. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains one or more error objects explaining"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"what went wrong."},"children":[]}]}]}],"type":"object","properties":{"success":{"type":"boolean","enum":[false],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for error responses."},"children":[]}]}]}]},"data":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for error responses."},"children":[]}]}]}]},"errors":{"type":"array","description":"One or more error objects describing the failure.","items":{"$ref":"#/components/schemas/ApiError"}}}}},"components/schemas/BaseSettings":{"id":"components/schemas/BaseSettings","kind":"json-schema","title":"BaseSettings","data":{"type":"object","properties":{"autoPassSingle":{"type":"boolean"},"backButton":{"type":"boolean"},"cardDesign":{"type":"boolean"},"forceShowCaptchaFromAdmin":{"type":"boolean"},"hideCaptcha":{"type":"boolean"},"isEnabledMessages":{"type":"boolean"},"isEnabledSaveAsDraft":{"type":"boolean"},"isEnabledSignupForSaveAsDraft":{"type":"boolean"},"isRtl":{"type":"boolean"},"isShouldShowCookieModal":{"type":"boolean"},"preventMultipleSubmissions":{"type":"boolean"},"removeBranding":{"type":"boolean"},"showSubmissionSummary":{"type":"boolean"},"steps":{"type":"boolean"},"captchaChoice":{"type":"boolean"},"cardDesignFadeIn":{"type":"boolean"},"cardDesignTransition":{"type":"string"},"hideFormTitle":{"type":"boolean"},"hideQuestionNumber":{"type":"boolean"},"isDisabledMessages":{"type":"boolean"},"isOnlySelectedUsers":{"type":"boolean"},"questionMustValid":{"type":"boolean"},"requireLoginForSubmission":{"type":"boolean"},"showLoginBeforeForm":{"type":"boolean"}}}},"components/schemas/Calculator":{"id":"components/schemas/Calculator","kind":"json-schema","title":"Calculator","data":{"type":"object","properties":{"questionId":{"type":"string"},"questionType":{"type":"string"},"actions":{"type":"array","items":{"type":"object","properties":{"answer":{"type":"string"},"command":{"type":"string","enum":["increase","decrease"]},"value":{"type":"number"}}}}}}},"components/schemas/Condition":{"id":"components/schemas/Condition","kind":"json-schema","title":"Condition","data":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"integer"},"triggers":{"type":"array","items":{"type":"object","properties":{"questionId":{"type":"string"},"answer":{"type":"array","items":{"type":"string"}},"operator":{"type":"string","enum":["and","or"]},"case":{"type":"string","enum":["is","is not","includes","startsWith","endsWith","greaterThan","lesserThan","isEmpty","isFilled"]}}}},"actions":{"type":"array","items":{"type":"object","properties":{"targetQuestionId":{"type":"string"},"action":{"type":"string","enum":["show","hide"]}}}}}}},"components/schemas/DesignSettings":{"id":"components/schemas/DesignSettings","kind":"json-schema","title":"DesignSettings","data":{"type":"object","properties":{"answerColor":{"type":"string"},"backgroundColor":{"type":"string"},"backgroundImage":{"type":"string","nullable":true},"borderColor":{"type":"string"},"borderRadius":{"type":"string"},"font":{"type":"string"},"fontSize":{"type":"string"},"inputColor":{"type":"string"},"mainColor":{"type":"string"},"questionColor":{"type":"string"},"themeName":{"type":"string"},"answerTextColor":{"type":"string"},"backgroundBrightness":{"type":"number"},"backgroundLayout":{"type":"string"},"backgroundPosition":{"type":"string"},"customCss":{"type":"array","items":{}},"customCssMediaRules":{"type":"array","items":{"type":"object","properties":{"width":{"type":"string"},"css":{"type":"array","items":{}}}}},"isCustomCssEnabled":{"type":"boolean"},"isEnabled":{"type":"boolean"}}}},"components/schemas/Logo":{"id":"components/schemas/Logo","kind":"json-schema","title":"Logo","data":{"type":"object","properties":{"align":{"type":"string"},"altText":{"type":"string"},"brightness":{"type":"number"},"image":{"type":"string"},"isEnabled":{"type":"boolean"},"radius":{"type":"number"},"sticky":{"type":"string"},"isDecorative":{"type":"boolean"},"layout":{"type":"string"}}}},"components/schemas/QuestionChoice":{"id":"components/schemas/QuestionChoice","kind":"json-schema","title":"QuestionChoice","data":{"type":"object","properties":{"subType":{"type":"string","description":"dropdown, multiplechoice, singlechoice, rating, picturechoice, opinionscale, ranking"},"min":{"type":"number"},"max":{"type":"number"},"other":{"type":"boolean"},"multipleSelection":{"type":"boolean"},"shuffleOptions":{"type":"boolean"},"options":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"text":{"type":"string"},"fileId":{"type":"string"},"altText":{"type":"string"}}}},"defaultValue":{"type":"array","items":{"type":"string"}},"otherIsRequired":{"type":"boolean"},"otherPlaceholder":{"type":"string"},"isShowEmptyoption":{"type":"boolean"},"emptyOption":{"type":"string"},"rateStyle":{"type":"string"},"showLabel":{"type":"boolean"},"labelLeft":{"type":"string"},"labelCenter":{"type":"string"},"labelRight":{"type":"string"},"isOrder":{"type":"boolean"},"isShowCommentField":{"type":"boolean"},"commentFieldHeader":{"type":"string"}}}},"components/schemas/QuestionText":{"id":"components/schemas/QuestionText","kind":"json-schema","title":"QuestionText","data":{"type":"object","properties":{"subType":{"type":"string","description":"shorttext, longtext, maskedtext"},"minLength":{"type":"number"},"maxLength":{"type":"number"},"defaultValue":{"type":"string"},"maskPattern":{"type":"string"},"maskChar":{"type":"string"},"regexValidation":{"type":"boolean"},"regex":{"type":"string"}}}},"components/schemas/QuestionImageUpload":{"id":"components/schemas/QuestionImageUpload","kind":"json-schema","title":"QuestionImageUpload","data":{"type":"object","properties":{"maxFileCount":{"type":"integer"}}}},"components/schemas/QuestionFileUpload":{"id":"components/schemas/QuestionFileUpload","kind":"json-schema","title":"QuestionFileUpload","data":{"type":"object","properties":{"allowedFileTypes":{"type":"array","items":{"type":"string"}},"maxFileCount":{"type":"integer"}}}},"components/schemas/QuestionMedia":{"id":"components/schemas/QuestionMedia","kind":"json-schema","title":"QuestionMedia","data":{"type":"object","properties":{"imageUrl":{"type":"string"},"videoUrl":{"type":"string"},"videoThumbnail":{"type":"string"},"iconUrl":{"type":"string"},"iconId":{"type":"string"},"iconColor":{"type":"string"},"size":{"type":"number"},"fileId":{"type":"string"},"cssClass":{"type":"string"},"mobileCssClass":{"type":"string"},"autoPlay":{"type":"boolean"},"nounProject":{"type":"object","properties":{"id":{"type":"string"}}},"fontawesome":{"type":"object","properties":{"id":{"type":"string"},"version":{"type":"string"},"style":{"type":"string"}}},"altText":{"type":"string"},"isDecorative":{"type":"boolean"},"align":{"type":"string"},"brightness":{"type":"number"}}}},"components/schemas/QuestionEmail":{"id":"components/schemas/QuestionEmail","kind":"json-schema","title":"QuestionEmail","data":{"type":"object","properties":{"labels":{"type":"object","properties":{"confirmation":{"type":"string"}}},"isShowConfirmation":{"type":"boolean"},"isLimitedDomain":{"type":"boolean"},"limitedDomain":{"type":"string"}}}},"components/schemas/QuestionFullname":{"id":"components/schemas/QuestionFullname","kind":"json-schema","title":"QuestionFullname","data":{"type":"object","properties":{"labels":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"prefix":{"type":"string"},"middle":{"type":"string"},"suffix":{"type":"string"}}},"middle":{"type":"boolean"},"prefix":{"type":"boolean"},"suffix":{"type":"boolean"}}}},"components/schemas/QuestionAddress":{"id":"components/schemas/QuestionAddress","kind":"json-schema","title":"QuestionAddress","data":{"type":"object","properties":{"labels":{"type":"object","properties":{"addressLine1":{"type":"string"},"addressLine2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"pcode":{"type":"string"},"country":{"type":"string"}}},"isShowAddressLine2":{"type":"boolean"},"isShowCity":{"type":"boolean"},"isShowState":{"type":"boolean"},"isShowPcode":{"type":"boolean"},"isShowCountry":{"type":"boolean"},"isShowMap":{"type":"boolean"},"showMapOnly":{"type":"boolean"},"defaultCountry":{"type":"array","items":{}},"defaultLocation":{"type":"object","properties":{"lat":{"type":"number"},"lng":{"type":"number"},"z":{"type":"number"}}},"defaultValue":{"type":"object","properties":{"addressLine1":{"type":"string"},"addressLine2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"pcode":{"type":"string"}}}}}},"components/schemas/QuestionTime":{"id":"components/schemas/QuestionTime","kind":"json-schema","title":"QuestionTime","data":{"type":"object","properties":{"defaultHour":{"type":"number"},"defaultMinute":{"type":"number"},"twelvehour":{"type":"boolean"},"doneText":{"type":"string"},"clearText":{"type":"string"},"cancelText":{"type":"string"}}}},"components/schemas/QuestionDate":{"id":"components/schemas/QuestionDate","kind":"json-schema","title":"QuestionDate","data":{"type":"object","properties":{"selectMonths":{"type":"boolean"},"selectYears":{"type":"number"},"today":{"type":"string"},"clear":{"type":"string"},"close":{"type":"string"},"format":{"type":"string","enum":["local","MM/DD/YYYY","DD/MM/YYYY","YYYY/MM/DD"]},"separator":{"type":"string","enum":["/",".","-"]},"isPast":{"type":"boolean"},"isFuture":{"type":"boolean"},"isWithTime":{"type":"boolean"},"timeFormat":{"type":"string","enum":["12","24"]},"timePlaceholder":{"type":"string"}}}},"components/schemas/QuestionPhone":{"id":"components/schemas/QuestionPhone","kind":"json-schema","title":"QuestionPhone","data":{"type":"object","properties":{"labels":{"type":"object","properties":{"countrycode":{"type":"string"},"areacode":{"type":"string"},"extension":{"type":"string"}}},"isShowCountrycode":{"type":"boolean"},"isShowAreacode":{"type":"boolean"},"isShowExtension":{"type":"boolean"},"mask":{"type":"boolean"},"maskPattern":{"type":"string"}}}},"components/schemas/QuestionNumber":{"id":"components/schemas/QuestionNumber","kind":"json-schema","title":"QuestionNumber","data":{"type":"object","properties":{"onlypositive":{"type":"boolean"},"decimals":{"type":"number"},"min":{"type":"number"},"max":{"type":"number"},"defaultValue":{"type":"number"}}}},"components/schemas/QuestionTermsAndConditions":{"id":"components/schemas/QuestionTermsAndConditions","kind":"json-schema","title":"QuestionTermsAndConditions","data":{"type":"object","properties":{"showQuestionTitle":{"type":"boolean"},"label":{"type":"object","properties":{"beforeLinkedText":{"type":"string"},"linkedText":{"type":"string"},"afterLinkedText":{"type":"string"}}},"content":{"type":"string"},"url":{"type":"string"}}}},"components/schemas/QuestionProductBasket":{"id":"components/schemas/QuestionProductBasket","kind":"json-schema","title":"QuestionProductBasket","data":{"type":"object","properties":{"currency":{"type":"string"},"discountCode":{"type":"boolean"},"tax":{"type":"object","properties":{"isEnabled":{"type":"boolean"},"rate":{"type":"number"},"type":{"type":"string","enum":["includes","excludes"]}}},"hideSummary":{"type":"boolean"},"viewType":{"type":"object","properties":{"viewTypes":{"type":"array","items":{"type":"string","enum":["grid","list","grid3"]}},"defaultViewType":{"type":"string","enum":["grid","list","grid3"]}}},"categories":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"parentId":{"type":"string"},"name":{"type":"string"}}}},"defaultCategory":{"type":"string"},"shippings":{"type":"array","items":{"type":"object","properties":{"fee":{"type":"number"},"isFree":{"type":"boolean"}}}},"products":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"},"price":{"type":"number"},"variantPrice":{"type":"object","properties":{"isEnable":{"type":"boolean"},"minPrice":{"type":"number"},"maxPrice":{"type":"number"}}},"unit":{"type":"string"},"desc":{"type":"string"},"longDesc":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"detailUrl":{"type":"string"},"hidden":{"type":"boolean"},"variants":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"options":{"type":"array","items":{"type":"string"}}}}},"fileIds":{"type":"array","items":{"type":"string"}},"fileId":{"type":"string"},"fileInfos":{"type":"object","additionalProperties":{"type":"object","properties":{"altText":{"type":"string"}}}},"stock":{"type":"object","properties":{"isEnable":{"type":"boolean"},"whenOutOfStock":{"type":"string","enum":["hide","disable","continue"]},"showRemainingStock":{"type":"boolean"}}},"categories":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"name":{"type":"string"}}}}}}}}}},"components/schemas/QuestionPayment":{"id":"components/schemas/QuestionPayment","kind":"json-schema","title":"QuestionPayment","data":{"type":"object","properties":{"currency":{"type":"string"},"amount":{"type":"number"},"canAmountBeEnter":{"type":"boolean"},"minAmount":{"type":"number"},"maxAmount":{"type":"number"},"relatedQuestionId":{"type":"string"},"testmode":{"type":"boolean"},"paymentPageTitle":{"type":"string"},"gateways":{"type":"object","properties":{"paypal":{"type":"boolean"},"iyzico":{"type":"boolean"},"wirecard":{"type":"boolean"},"mokapazaryeri":{"type":"boolean"},"mokadealer":{"type":"boolean"},"stripe":{"type":"boolean"},"cash":{"type":"boolean"},"bankTransfer":{"type":"boolean"}}},"cashDesc":{"type":"string"},"cashOptionTypes":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"}}}},"defaultGateway":{"type":"string"},"gatewayOrder":{"type":"array","items":{"type":"string"}},"gatewaySettings":{"type":"object"}}}},"components/schemas/QuestionSelectionMatrix":{"id":"components/schemas/QuestionSelectionMatrix","kind":"json-schema","title":"QuestionSelectionMatrix","data":{"type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["radio","checkbox"]},"text":{"type":"string"}}}},"columns":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"}}}},"defaultValue":{"type":"object"},"requiredEachRow":{"type":"boolean"}}}},"components/schemas/QuestionGrid":{"id":"components/schemas/QuestionGrid","kind":"json-schema","title":"QuestionGrid","data":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["text","date","number","dropdown","maskedtext"]},"hidden":{"type":"boolean"},"required":{"type":"boolean"},"placeholder":{"type":"string"},"sumOption":{"type":"boolean"},"options":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"}}}},"maskPattern":{"type":"string"},"date":{"type":"object","properties":{"format":{"type":"string","enum":["local","MM/DD/YYYY","DD/MM/YYYY","YYYY/MM/DD"]},"separator":{"type":"string","enum":["/",".","-"]}}}}}},"hasRowLimit":{"type":"boolean"},"rowLimitCount":{"type":"number"},"allRowOpen":{"type":"boolean"}}}},"components/schemas/QuestionDrawing":{"id":"components/schemas/QuestionDrawing","kind":"json-schema","title":"QuestionDrawing","data":{"type":"object","properties":{"subType":{"type":"string","description":"drawing or signature"},"backgroundFileId":{"type":"string"},"isUserUploadBackground":{"type":"boolean"},"lineColor":{"type":"string"}}}},"components/schemas/Question":{"id":"components/schemas/Question","kind":"json-schema","title":"Question","data":{"type":"object","properties":{"_id":{"type":"string"},"displayOrder":{"type":"integer"},"isActive":{"type":"boolean"},"isDeleted":{"type":"boolean"},"isRequired":{"type":"boolean"},"question":{"type":"string"},"questionType":{"type":"string"},"description":{"type":"string"},"hiddenQuestion":{"type":"boolean"},"readonly":{"type":"boolean"},"parentId":{"type":"string"},"choice":{"$ref":"#/components/schemas/QuestionChoice"},"text":{"$ref":"#/components/schemas/QuestionText"},"imageUpload":{"$ref":"#/components/schemas/QuestionImageUpload"},"fileUpload":{"$ref":"#/components/schemas/QuestionFileUpload"},"isWithAi":{"type":"boolean"},"placeholder":{"type":"string"},"getValueFromUrl":{"type":"boolean"},"showOnResponses":{"type":"boolean"},"media":{"$ref":"#/components/schemas/QuestionMedia"},"email":{"$ref":"#/components/schemas/QuestionEmail"},"fullname":{"$ref":"#/components/schemas/QuestionFullname"},"address":{"$ref":"#/components/schemas/QuestionAddress"},"time":{"$ref":"#/components/schemas/QuestionTime"},"date":{"$ref":"#/components/schemas/QuestionDate"},"phone":{"$ref":"#/components/schemas/QuestionPhone"},"number":{"$ref":"#/components/schemas/QuestionNumber"},"termsandconditions":{"$ref":"#/components/schemas/QuestionTermsAndConditions"},"imageContent":{"type":"object"},"pagebreak":{"type":"object"},"wysiwyg":{"type":"object","properties":{"content":{"type":"string"}}},"productbasket":{"$ref":"#/components/schemas/QuestionProductBasket"},"payment":{"$ref":"#/components/schemas/QuestionPayment"},"selectionmatrix":{"$ref":"#/components/schemas/QuestionSelectionMatrix"},"grid":{"$ref":"#/components/schemas/QuestionGrid"},"drawing":{"$ref":"#/components/schemas/QuestionDrawing"},"questiongroup":{"type":"object"}}}},"components/schemas/SubmitButton":{"id":"components/schemas/SubmitButton","kind":"json-schema","title":"SubmitButton","data":{"type":"object","properties":{"align":{"type":"string","enum":["left","center","right"]},"isShow":{"type":"boolean"},"text":{"type":"string"}}}},"components/schemas/ThankYouPage":{"id":"components/schemas/ThankYouPage","kind":"json-schema","title":"ThankYouPage","data":{"type":"object","properties":{"_id":{"type":"string"},"desc":{"type":"string"},"isSaveAndReturn":{"type":"boolean"},"isShareRecords":{"type":"boolean"},"isShowResponseCount":{"type":"boolean"},"popupBtnText":{"type":"string"},"popupText":{"type":"string"},"popupTitle":{"type":"string"},"redirectAfterSubmit":{"type":"boolean"},"redirectUrl":{"type":"string"},"showPrintButton":{"type":"boolean"},"showPublicId":{"type":"boolean"},"showShare":{"type":"boolean"},"showStatistic":{"type":"boolean"},"showThankYouPage":{"type":"boolean"},"statisticDesc":{"type":"string"},"statisticTitle":{"type":"string"},"title":{"type":"string"},"pdfTemplateId":{"type":"string"}}}},"components/schemas/AfterSubmissionSettings":{"id":"components/schemas/AfterSubmissionSettings","kind":"json-schema","title":"AfterSubmissionSettings","data":{"type":"object","properties":{"isRedirect":{"type":"boolean"},"isSaveAndReturn":{"type":"boolean"},"redirectUrl":{"type":"string"},"showReportPage":{"type":"boolean"},"showThankYouPage":{"type":"boolean"}}}},"components/schemas/CalculatorSettings":{"id":"components/schemas/CalculatorSettings","kind":"json-schema","title":"CalculatorSettings","data":{"type":"object","properties":{"calculatorDetailText":{"type":"string"},"calculatorResultText":{"type":"string"},"customizeMessages":{"type":"array","items":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"},"message":{"type":"string"}}}},"isShowCalculatorDetail":{"type":"boolean"},"isShowCalculatorResult":{"type":"boolean"},"isShowCustomizeMessage":{"type":"boolean"}}}},"components/schemas/ConversionCodes":{"id":"components/schemas/ConversionCodes","kind":"json-schema","title":"ConversionCodes","data":{"type":"object","properties":{"remarketing":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"provider":{"type":"string"},"eventName":{"type":"string"}}}}}}},"components/schemas/Cover":{"id":"components/schemas/Cover","kind":"json-schema","title":"Cover","data":{"type":"object","properties":{"altText":{"type":"string"},"brightness":{"type":"number"},"image":{"type":"string"},"isDecorative":{"type":"boolean"},"isEnabled":{"type":"boolean"},"layout":{"type":"string"},"position":{"type":"string"},"zoom":{"type":"number"}}}},"components/schemas/DirectMessageSettings":{"id":"components/schemas/DirectMessageSettings","kind":"json-schema","title":"DirectMessageSettings","data":{"type":"object","properties":{"facebook":{"type":"object","properties":{"isEnable":{"type":"boolean"},"messengerAddress":{"type":"string"}}},"whatsapp":{"type":"object","properties":{"isEnable":{"type":"boolean"},"phone":{"type":"string"}}}}}},"components/schemas/LastEdited":{"id":"components/schemas/LastEdited","kind":"json-schema","title":"LastEdited","data":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"fullname":{"type":"string"},"userId":{"type":"string"}}}},"components/schemas/LocationSettings":{"id":"components/schemas/LocationSettings","kind":"json-schema","title":"LocationSettings","data":{"type":"object","properties":{"isEnable":{"type":"boolean"},"lat":{"type":"number"},"lng":{"type":"number"},"provinceCode":{"type":"string"},"radius":{"type":"number"}}}},"components/schemas/MetaData":{"id":"components/schemas/MetaData","kind":"json-schema","title":"MetaData","data":{"type":"object","properties":{"description":{"type":"string"},"fileId":{"type":"string"},"title":{"type":"string"}}}},"components/schemas/PageSettings":{"id":"components/schemas/PageSettings","kind":"json-schema","title":"PageSettings","data":{"type":"object","properties":{"firstPageId":{"type":"string"},"firstPageTitle":{"type":"string"}}}},"components/schemas/DateActionSettings":{"id":"components/schemas/DateActionSettings","kind":"json-schema","title":"DateActionSettings","data":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"isEnabled":{"type":"boolean"},"redirectButtonText":{"type":"string"},"redirectUrl":{"type":"string"},"wysiwyg":{"type":"string"}}}},"components/schemas/ThankYouPageSettings":{"id":"components/schemas/ThankYouPageSettings","kind":"json-schema","title":"ThankYouPageSettings","data":{"type":"object","properties":{"desc":{"type":"string"},"hidePrintButton":{"type":"boolean"},"hideShare":{"type":"boolean"},"showPublicId":{"type":"boolean"},"title":{"type":"string"}}}},"components/schemas/Timer":{"id":"components/schemas/Timer","kind":"json-schema","title":"Timer","data":{"type":"object","properties":{"hoursText":{"type":"string"},"isCountUp":{"type":"boolean"},"isEnabled":{"type":"boolean"},"minutesText":{"type":"string"},"seconds":{"type":"number"},"secondsText":{"type":"string"},"timeExpiredButton":{"type":"string"},"timeExpiredButtonWithInvalidForm":{"type":"string"},"timeExpiredMessage":{"type":"string"},"timeExpiredMessageWithInvalidForm":{"type":"string"},"timeExpiredTitle":{"type":"string"}}}},"components/schemas/WelcomePageSettings":{"id":"components/schemas/WelcomePageSettings","kind":"json-schema","title":"WelcomePageSettings","data":{"type":"object","properties":{"buttonText":{"type":"string"},"desc":{"type":"string"},"showWelcomePage":{"type":"boolean"},"title":{"type":"string"}}}},"components/schemas/Form":{"id":"components/schemas/Form","kind":"json-schema","title":"Form","data":{"type":"object","properties":{"_id":{"type":"string"},"baseSettings":{"$ref":"#/components/schemas/BaseSettings"},"calculators":{"type":"array","items":{"$ref":"#/components/schemas/Calculator"}},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/Condition"}},"createDate":{"type":"string","format":"date-time"},"updateDate":{"type":"string","format":"date-time"},"creatorId":{"type":"string"},"currencySymbolLocation":{"type":"string","enum":["before","after","symbol"]},"designSettings":{"$ref":"#/components/schemas/DesignSettings"},"isArchived":{"type":"boolean"},"isTrash":{"type":"boolean"},"isUsedCalculator":{"type":"boolean"},"isUserInaccessible":{"type":"boolean"},"logo":{"$ref":"#/components/schemas/Logo"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/Question"}},"state":{"type":"string","enum":["public","unlisted","private"]},"submitButton":{"$ref":"#/components/schemas/SubmitButton"},"supportedLanguages":{"type":"array","items":{"type":"string"}},"thankYouPages":{"type":"array","items":{"$ref":"#/components/schemas/ThankYouPage"}},"title":{"type":"string"},"version":{"type":"integer"},"afterSubmissionSettings":{"$ref":"#/components/schemas/AfterSubmissionSettings"},"calculatorSettings":{"$ref":"#/components/schemas/CalculatorSettings"},"conversionCodes":{"$ref":"#/components/schemas/ConversionCodes"},"cover":{"$ref":"#/components/schemas/Cover"},"defaultLanguage":{"type":"string"},"directMessageSettings":{"$ref":"#/components/schemas/DirectMessageSettings"},"enableCustomMessage":{"type":"boolean"},"folderIds":{"type":"array","items":{"type":"string"}},"googleMapApiKey":{"type":"string"},"importedFormId":{"type":"string"},"importedUserId":{"type":"string"},"isEnabledWhenDowngrade":{"type":"boolean"},"isImportUncomplated":{"type":"boolean"},"isStarred":{"type":"boolean"},"isSuspended":{"type":"boolean","nullable":true},"isSuspendedWhenDowngrade":{"type":"boolean"},"lastEdited":{"$ref":"#/components/schemas/LastEdited"},"locationSettings":{"$ref":"#/components/schemas/LocationSettings"},"metaData":{"$ref":"#/components/schemas/MetaData"},"pageSettings":{"$ref":"#/components/schemas/PageSettings"},"publishDateSettings":{"$ref":"#/components/schemas/DateActionSettings"},"unpublishDateSettings":{"$ref":"#/components/schemas/DateActionSettings"},"reportState":{"type":"string"},"thankYouPageSettings":{"$ref":"#/components/schemas/ThankYouPageSettings"},"timer":{"$ref":"#/components/schemas/Timer"},"trashDate":{"type":"string","format":"date-time"},"userInfo":{"type":"object"},"userLabelSetId":{"type":"string"},"welcomePageSettings":{"$ref":"#/components/schemas/WelcomePageSettings"},"withAI":{"type":"boolean"}}}},"components/schemas/AnswerUserInfo":{"id":"components/schemas/AnswerUserInfo","kind":"json-schema","title":"AnswerUserInfo","data":{"type":"object","properties":{"fullname":{"type":"string"}}}},"components/schemas/QuestionAnswer":{"id":"components/schemas/QuestionAnswer","kind":"json-schema","title":"QuestionAnswer","data":{"type":"object","properties":{"q":{"type":"string"},"t":{"type":"string"},"n":{"type":"number"},"d":{"type":"string","format":"date-time"},"b":{"type":"boolean"},"c":{"type":"array","items":{"type":"object","properties":{"t":{"type":"string"},"v":{"type":"string"},"o":{"type":"string"}}}},"fn":{"type":"object","properties":{"f":{"type":"string"},"l":{"type":"string"},"m":{"type":"string"},"p":{"type":"string"},"s":{"type":"string"}}},"a":{"type":"object","properties":{"a1":{"type":"string"},"a2":{"type":"string"},"c":{"type":"string"},"s":{"type":"string"},"p":{"type":"string"},"co":{"type":"object","properties":{"c":{"type":"string"},"n":{"type":"string"}}},"l":{"type":"object","properties":{"lat":{"type":"number"},"lng":{"type":"number"},"z":{"type":"number"}}}}},"p":{"type":"object","properties":{"c":{"type":"string"},"a":{"type":"string"},"p":{"type":"string"},"e":{"type":"string"}}},"f":{"type":"array","items":{"type":"object","properties":{"fid":{"type":"string"},"t":{"type":"string"},"s":{"type":"number"}}}},"ti":{"type":"object","properties":{"h":{"type":"number"},"m":{"type":"number"}}},"pb":{"type":"object","properties":{"c":{"type":"string"},"t":{"type":"number"},"sf":{"type":"number"},"tx":{"type":"object","properties":{"a":{"type":"number"},"t":{"type":"string"},"r":{"type":"number"}}},"d":{"type":"object","properties":{"a":{"type":"number"},"c":{"type":"string"},"t":{"type":"string"},"v":{"type":"number"}}},"p":{"type":"array","items":{"type":"object","properties":{"pid":{"type":"string"},"n":{"type":"string"},"ta":{"type":"array","items":{"type":"string"}},"p":{"type":"number"},"u":{"type":"string"},"a":{"type":"number"},"t":{"type":"number"},"v":{"type":"array","items":{"type":"object","properties":{"n":{"type":"string"},"v":{"type":"string"}}}}}}}}},"py":{"type":"object","properties":{"pid":{"type":"string"},"a":{"type":"number"},"c":{"type":"string"},"gw":{"type":"string"},"rc":{"type":"string"},"ct":{"type":"array","items":{"type":"string"}},"b":{"type":"object","properties":{"n":{"type":"string"},"sn":{"type":"string"},"e":{"type":"string"},"i":{"type":"string"},"a":{"type":"string"},"ci":{"type":"string"},"co":{"type":"string"}}}}},"sm":{"type":"array","items":{"type":"object","properties":{"rid":{"type":"string"},"rn":{"type":"string"},"rt":{"type":"string"},"c":{"type":"array","items":{"type":"object","properties":{"cid":{"type":"string"},"cn":{"type":"string"}}}}}}},"g":{"type":"array","items":{"type":"object","properties":{"c":{"type":"array","items":{"type":"object","properties":{"cid":{"type":"string"},"cn":{"type":"string"},"d":{"type":"string","format":"date-time"},"n":{"type":"number"},"t":{"type":"string"},"mt":{"type":"string"}}}}}}},"dw":{"type":"object","properties":{"fid":{"type":"string"}}},"ac":{"type":"string"}}}},"components/schemas/AnswerPoint":{"id":"components/schemas/AnswerPoint","kind":"json-schema","title":"AnswerPoint","data":{"type":"object","properties":{"tp":{"type":"number"},"pl":{"type":"array","items":{"type":"object","properties":{"q":{"type":"string"},"p":{"type":"number"},"c":{"type":"string","enum":["increase","decrease"]}}}}}}},"components/schemas/Answer":{"id":"components/schemas/Answer","kind":"json-schema","title":"Answer","data":{"type":"object","properties":{"answerFiles":{"type":"array","items":{}},"userInfo":{"$ref":"#/components/schemas/AnswerUserInfo"},"answers":{"type":"array","items":{"$ref":"#/components/schemas/QuestionAnswer"}},"id":{"type":"string"},"point":{"$ref":"#/components/schemas/AnswerPoint"},"publicId":{"type":"string"},"createDate":{"type":"string","format":"date-time"},"_id":{"type":"string"},"fileToken":{"type":"string"}}}},"components/schemas/AnswerPage":{"id":"components/schemas/AnswerPage","kind":"json-schema","title":"AnswerPage","data":{"type":"object","properties":{"totalCount":{"type":"integer"},"result":{"type":"array","items":{"$ref":"#/components/schemas/Answer"}},"searchAfter":{"type":"array","items":{"type":"integer"}}}}},"schema_6":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SuccessWrapper"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FormListItem"}}}}]},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"string"},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SuccessWrapper"},{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Form"}}}]},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"integer","minimum":1},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/SuccessWrapper"},{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AnswerPage"}}}]},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"type":"object","properties":{"status":{"type":"string","enum":["ok"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"ok\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the gateway is healthy."},"children":[]}]}]}]},"now":{"type":"string","description":"Current gateway time as a Go time string."},"agents":{"type":"object","description":"Status of any registered async agents (empty object when none are configured)."}}},"id":"schema_11"}},"exampleStore":{"paths/~1v1~1health/get/responses/200/content/application~1json/example":{"value":{"status":"ok","now":"2024-03-15 10:30:00.000000000 +0000 UTC m=+3600.123","agents":{}},"id":"paths/~1v1~1health/get/responses/200/content/application~1json/example"}},"securitySchemeStore":{"BearerAuth":{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth 2.0 Bearer token (HS256 JWT) issued by the forms.app OAuth 2.0 flow."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass the token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Bearer <your_token>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Bearer <your_token>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cannot be combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — use one or the other per request."},"children":[]}]}]}]},"ApiKeyAuth":{"id":"ApiKeyAuth","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API key generated from your forms.app account settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass the key in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-Api-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"X-Api-Key: <your_api_key>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"X-Api-Key: <your_api_key>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How to create an API key:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://forms.app"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"forms.app"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create API Key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", give it a name, and copy the key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key is shown "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only once"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — store it securely."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cannot be combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — use one or the other per request."},"children":[]}]}]}],"in":"header","paramName":"X-Api-Key"}},"servers":[{"url":"/_mock/apis","isMockServer":true,"description":"Mock server"},{"url":"https://api.forms.app"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/apis","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/index.json?download"},{"url":"/_bundle/apis/index.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"forms.app API","description":"## Overview\n\nThe **forms.app API** gives you programmatic, read-only access to your forms and their\nsubmissions. You can list all the forms in your account, fetch a specific form's complete\nstructure (questions, design settings, submission behaviour, thank-you pages), and page\nthrough the answers your respondents have submitted.\n\n## Authentication\n\nEvery request must be authenticated with exactly **one** of the two methods below.\nProviding both in the same request is not allowed and will return `401 Unauthorized`.\n\n### Option 1 — OAuth 2.0 Bearer Token\n\nObtain a JWT via the forms.app OAuth 2.0 flow and pass it in the `Authorization` header:\n\n```\nAuthorization: Bearer <your_token>\n```\n\n### Option 2 — API Key\n\nPass your API key in the `X-Api-Key` header:\n\n```\nX-Api-Key: <your_api_key>\n```\n\n#### How to create an API key\n\n1. Log in to [forms.app](https://forms.app).\n2. Click your avatar in the top-right corner and open **Account Settings**.\n3. Go to the **API Keys** tab.\n4. Click **Create API Key**, enter a descriptive name, and confirm.\n5. Copy the generated key immediately — it is shown **only once**.\n6. Store it securely (e.g. in an environment variable or secret manager).\n\n> You can create multiple keys (one per integration), and revoke any of them at any time\n> from the same **API Keys** settings page.\n\n> **Newly created or re-activated keys:** for up to ~30 seconds, a key whose validation\n> recently failed may keep returning `401 Unauthorized` from a short-lived cache. If a key\n> you just created or re-activated is rejected, wait ~30 seconds and retry.\n\n## Response Envelope\n\nAll endpoints return a consistent JSON envelope:\n\n**Success (`2xx`)**\n```json\n{\n  \"success\": true,\n  \"data\": { },\n  \"errors\": []\n}\n```\n\n**Error (`4xx` / `5xx`)**\n```json\n{\n  \"success\": false,\n  \"data\": null,\n  \"errors\": [\n    { \"errorCode\": 1001, \"errorMessage\": \"Unauthorized\" }\n  ]\n}\n```\n\n## Rate Limiting\n\nRequests are rate-limited per API key / token (falling back to client IP when neither is\npresent). You may send up to **300 requests per 60-second window**. When the limit is\nexceeded the API returns `429 Too Many Requests` with a `Retry-After` header indicating how\nmany seconds to wait before the window resets. Wait for that period and retry — do not spam\nthe endpoint in a tight loop.\n\nA short-term burst limit also applies per endpoint (about **50 requests per second**, with a\nburst allowance up to **100**). Spread requests out rather than firing them in a tight burst\nto avoid transient `429` responses.\n"}},"baseSlug":"/apis","routesMapping":{}}