Custom page title (page_title), description (page_description), link preview image (page_thumbnail), and favicon (page_favicon). Published on cloud Pro and higher plans, on both OpnForm URLs and custom domains.
An array of field and layout blocks that make up the form.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"OpnForm Technical Docs","colors":{"primary":"#3b82f6","light":"#60a5fa","dark":"#2563eb"},"logo":{"light":"https://mintcdn.com/opnform/OUqYLvFvGemD8lSt/logo.svg?fit=max\u0026auto=format\u0026n=OUqYLvFvGemD8lSt\u0026q=85\u0026s=60c8619bcad52d227a058cc4a5f06955","dark":"https://mintcdn.com/opnform/OUqYLvFvGemD8lSt/logo.svg?fit=max\u0026auto=format\u0026n=OUqYLvFvGemD8lSt\u0026q=85\u0026s=60c8619bcad52d227a058cc4a5f06955"},"favicon":"https://mintcdn.com/opnform/OUqYLvFvGemD8lSt/logo.svg?fit=max\u0026auto=format\u0026n=OUqYLvFvGemD8lSt\u0026q=85\u0026s=60c8619bcad52d227a058cc4a5f06955","navbar":{"links":[{"href":"https://opnform.com?utm_source=docs\u0026utm_medium=topbar\u0026utm_campaign=technical_docs","label":"OpnForm"},{"href":"https://github.com/OpnForm/OpnForm","label":"GitHub"}],"primary":{"type":"button","label":"Dashboard","href":"https://opnform.com"}},"footer":{"socials":{"twitter":"https://twitter.com/opnform","github":"https://github.com/OpnForm/OpnForm"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Product Documentation","icon":"book-open-cover","href":"https://help.opnform.com"},{"anchor":"Community","icon":"discord","href":"https://discord.gg/YTSjU2a9TS"},{"anchor":"Changelog","icon":"sparkles","href":"https://feedback.opnform.com/changelog"},{"anchor":"Roadmap","icon":"road","href":"https://feedback.opnform.com/roadmap"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"opnform","hasAudioNarration":false,"actualSubdomain":"opnform","customDomains":["docs.opnform.com"],"gitSource":{"type":"github","owner":"opnform","repo":"opnform","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae4765f812f7e980ce50ded","collectionId":"5e6479b9-2264-435b-92e1-fde87b676701","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae4765f812f7e980ce50ded"},"feedback":{"edits":true,"thumbs":true},"entitlements":{},"buildId":"6ae4765f812f7e980ce50ded","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"API Reference","count":38},{"language":"default","tag":"Documentation","count":29},{"language":"default","tag":"Contributing","count":11},{"language":"default","tag":"Configuration","count":9},{"language":"default","tag":"Integrations","count":8},{"language":"default","tag":"Workspace Users","count":8},{"language":"default","tag":"Self-hosted Enterprise","count":7},{"language":"default","tag":"Submissions","count":6},{"language":"default","tag":"Deployment","count":6},{"language":"default","tag":"Forms","count":5}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/forms/get-form","slug":"/api-reference/forms/get-form","pageMetadata":{"openapi":"get /open/forms/{slug}","title":"Get Form","description":"Retrieve a single form.","href":"/api-reference/forms/get-form"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieve a single form.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`1`,id:`get-form`,children:`Get Form`}),`\n`,_jsxs(_components.p,{children:[`Retrieve a single form by its `,_jsx(_components.strong,{children:`slug`}),` (UUID or human-readable slug).`]}),`\n`,_jsx(Heading,{level:`2`,id:`authentication-\u0026-scope`,children:`Authentication \u0026 Scope`}),`\n`,_jsxs(_components.p,{children:[`Requires a token with the `,_jsx(_components.code,{children:`forms-read`}),` ability.`]}),`\n`,_jsx(Heading,{level:`2`,id:`request`,children:`Request`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`http`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`http`,children:_jsxs(_components.code,{language:`http`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`GET`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` /open/forms/{slug} `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`HTTP`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`/`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1.1`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`Host`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` api.opnform.com`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`Authorization`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` Bearer \u003ctoken>`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`path-parameters`,children:`Path Parameters`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Parameter`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Description`})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`slug`}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`The form slug or UUID (see dashboard)`})]})})]}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`200 OK`}),` – Returns a `,_jsx(_components.code,{children:`Form`}),` object.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`7`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`7`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`42`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"slug\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"customer-feedback\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"title\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Customer Feedback\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"visibility\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"public\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"properties\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#82071E`,\"--shiki-light-font-style\":`italic`,\"--shiki-dark\":`#F44747`,\"--shiki-dark-font-style\":`inherit`},children:`...`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`]`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`404 Not Found`}),` – No form matches the provided slug.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`403 Forbidden`}),` – The token lacks the required ability or you do not have permission to view the form.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"get /open/forms/{slug}","title":"Get Form","description":"Retrieve a single form.","href":"/api-reference/forms/get-form"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Get Form","slug":"get-form","depth":1,"children":[]},{"title":"Authentication \u0026 Scope","slug":"authentication-\u0026-scope","depth":2,"children":[]},{"title":"Request","slug":"request","depth":2,"children":[{"title":"Path Parameters","slug":"path-parameters","depth":3,"children":[]}]},{"title":"Response","slug":"response","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Forms"],"summary":"Get Form","description":"Retrieve a single form.","security":["a65cc977-b4fc-40ba-a870-ba22a619001a"],"parameters":["e439262f-9598-4586-82fe-fe9824876124"],"responses":{"200":"c8b316fc-3275-4eaa-b52a-7e6676ae6807","403":"82f9823a-614f-466f-9759-ac593f413be7","404":"11b8d462-de37-4371-a06b-226e4168cb4f"},"method":"get","type":"path","servers":["76717736-54ad-4f96-9ae4-ef1fd42de952"],"path":"/open/forms/{slug}","baseUrlOptions":["https://api.opnform.com"],"title":"Get Form","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"e439262f-9598-4586-82fe-fe9824876124":{"name":"slug","in":"path","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"c8b316fc-3275-4eaa-b52a-7e6676ae6807":{"description":"Successful","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"number","description":"The unique identifier for the form.","readOnly":true,"uniqueKey":"id","typeLabel":"number"},"slug":{"type":"string","description":"The URL-friendly slug for the form.","readOnly":true,"uniqueKey":"slug","typeLabel":"string"},"title":{"type":"string","description":"The title of the form.","uniqueKey":"title","typeLabel":"string"},"visibility":{"type":"string","enum":["public","draft","closed"],"description":"The current visibility state of the form.","uniqueKey":"visibility","typeLabel":"enum\u003cstring>"},"tags":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"tags.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"tags.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"tags","typeLabel":"string[] | null"},"language":{"type":"string","description":"Two-letter ISO language code.","uniqueKey":"language","typeLabel":"string"},"custom_domain":{"oneOf":[{"type":"string","uniqueKey":"custom_domain.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"custom_domain.oneOf.1","typeLabel":"null"}],"uniqueKey":"custom_domain","typeLabel":"string | null"},"theme":{"type":"string","enum":["default","simple","notion"],"uniqueKey":"theme","typeLabel":"enum\u003cstring>"},"font_family":{"oneOf":[{"type":"string","uniqueKey":"font_family.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"font_family.oneOf.1","typeLabel":"null"}],"uniqueKey":"font_family","typeLabel":"string | null"},"color":{"type":"string","uniqueKey":"color","typeLabel":"string"},"dark_mode":{"type":"string","enum":["light","dark","auto"],"uniqueKey":"dark_mode","typeLabel":"enum\u003cstring>"},"width":{"type":"string","enum":["centered","full"],"uniqueKey":"width","typeLabel":"enum\u003cstring>"},"size":{"type":"string","enum":["sm","md","lg"],"uniqueKey":"size","typeLabel":"enum\u003cstring>"},"border_radius":{"type":"string","enum":["none","small","full"],"uniqueKey":"border_radius","typeLabel":"enum\u003cstring>"},"layout_rtl":{"type":"boolean","uniqueKey":"layout_rtl","typeLabel":"boolean"},"uppercase_labels":{"type":"boolean","uniqueKey":"uppercase_labels","typeLabel":"boolean"},"cover_picture":{"oneOf":[{"type":"string","format":"uri","uniqueKey":"cover_picture.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","uniqueKey":"cover_picture.oneOf.1","typeLabel":"null"}],"uniqueKey":"cover_picture","typeLabel":"string\u003curi> | null"},"logo_picture":{"oneOf":[{"type":"string","format":"uri","uniqueKey":"logo_picture.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","uniqueKey":"logo_picture.oneOf.1","typeLabel":"null"}],"uniqueKey":"logo_picture","typeLabel":"string\u003curi> | null"},"no_branding":{"type":"boolean","description":"Whether to hide the OpnForm branding.","uniqueKey":"no_branding","typeLabel":"boolean"},"transparent_background":{"type":"boolean","description":"Transparent background when form is embedded.","uniqueKey":"transparent_background","typeLabel":"boolean"},"submit_button_text":{"type":"string","maxLength":50,"uniqueKey":"submit_button_text","typeLabel":"string"},"submitted_text":{"type":"string","maxLength":2000,"uniqueKey":"submitted_text","typeLabel":"string"},"redirect_url":{"oneOf":[{"type":"string","format":"uri","uniqueKey":"redirect_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","uniqueKey":"redirect_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"redirect_url","typeLabel":"string\u003curi> | null"},"re_fillable":{"type":"boolean","uniqueKey":"re_fillable","typeLabel":"boolean"},"re_fill_button_text":{"type":"string","maxLength":50,"uniqueKey":"re_fill_button_text","typeLabel":"string"},"confetti_on_submission":{"type":"boolean","uniqueKey":"confetti_on_submission","typeLabel":"boolean"},"show_progress_bar":{"type":"boolean","uniqueKey":"show_progress_bar","typeLabel":"boolean"},"submission_retention_value":{"oneOf":[{"type":"integer","minimum":1,"maximum":3650,"description":"Number of retention units before a submission is permanently deleted. Set this and submission_retention_unit to null to disable automatic deletion.","uniqueKey":"submission_retention_value.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"maximum":3650,"description":"Number of retention units before a submission is permanently deleted. Set this and submission_retention_unit to null to disable automatic deletion.","uniqueKey":"submission_retention_value.oneOf.1","typeLabel":"null"}],"uniqueKey":"submission_retention_value","typeLabel":"integer | null"},"submission_retention_unit":{"oneOf":[{"type":"string","enum":["day","week","month","year"],"description":"Calendar unit used by submission_retention_value. Both retention fields must be provided together.","uniqueKey":"submission_retention_unit.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["day","week","month","year"],"description":"Calendar unit used by submission_retention_value. Both retention fields must be provided together.","uniqueKey":"submission_retention_unit.oneOf.1","typeLabel":"null"}],"uniqueKey":"submission_retention_unit","typeLabel":"enum\u003cstring> | null"},"closes_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"closes_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"closes_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"closes_at","typeLabel":"string\u003cdate-time> | null"},"closed_text":{"oneOf":[{"type":"string","uniqueKey":"closed_text.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"closed_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"closed_text","typeLabel":"string | null"},"max_submissions_count":{"oneOf":[{"type":"integer","minimum":1,"uniqueKey":"max_submissions_count.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"uniqueKey":"max_submissions_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"max_submissions_count","typeLabel":"integer | null"},"max_submissions_reached_text":{"oneOf":[{"type":"string","uniqueKey":"max_submissions_reached_text.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"max_submissions_reached_text.oneOf.1","typeLabel":"null"}],"uniqueKey":"max_submissions_reached_text","typeLabel":"string | null"},"auto_save":{"type":"boolean","uniqueKey":"auto_save","typeLabel":"boolean"},"auto_focus":{"type":"boolean","uniqueKey":"auto_focus","typeLabel":"boolean"},"enable_partial_submissions":{"type":"boolean","uniqueKey":"enable_partial_submissions","typeLabel":"boolean"},"editable_submissions":{"type":"boolean","uniqueKey":"editable_submissions","typeLabel":"boolean"},"editable_submissions_button_text":{"type":"string","maxLength":50,"uniqueKey":"editable_submissions_button_text","typeLabel":"string"},"password":{"oneOf":[{"type":"string","uniqueKey":"password.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"password.oneOf.1","typeLabel":"null"}],"uniqueKey":"password","typeLabel":"string | null"},"use_captcha":{"type":"boolean","uniqueKey":"use_captcha","typeLabel":"boolean"},"captcha_provider":{"type":"string","enum":["recaptcha","hcaptcha"],"uniqueKey":"captcha_provider","typeLabel":"enum\u003cstring>"},"can_be_indexed":{"type":"boolean","uniqueKey":"can_be_indexed","typeLabel":"boolean"},"seo_meta":{"oneOf":[{"type":"object","description":"Custom page title (page_title), description (page_description), link preview image (page_thumbnail), and favicon (page_favicon). Published on cloud Pro and higher plans, on both OpnForm URLs and custom domains.","uniqueKey":"seo_meta.oneOf.0","typeLabel":"object"},{"type":"null","description":"Custom page title (page_title), description (page_description), link preview image (page_thumbnail), and favicon (page_favicon). Published on cloud Pro and higher plans, on both OpnForm URLs and custom domains.","uniqueKey":"seo_meta.oneOf.1","typeLabel":"null"}],"uniqueKey":"seo_meta","typeLabel":"object | null"},"custom_code":{"oneOf":[{"type":"string","uniqueKey":"custom_code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"custom_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"custom_code","typeLabel":"string | null"},"database_fields_update":{"oneOf":[{"type":"array","items":{"oneOf":[{}],"uniqueKey":"database_fields_update.oneOf.0.items.[INDEX]","typeLabel":"any"},"uniqueKey":"database_fields_update.oneOf.0","typeLabel":"any[]"},{"type":"null","items":{"oneOf":[{}]},"uniqueKey":"database_fields_update.oneOf.1","typeLabel":"null"}],"uniqueKey":"database_fields_update","typeLabel":"any[] | null"},"properties":{"type":"array","description":"An array of field and layout blocks that make up the form.","items":{"type":"object","description":"A single field or layout block within a form.","properties":{"id":{"type":"string","description":"A unique identifier for the block.","format":"uuid","uniqueKey":"properties.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","description":"The type of block.","uniqueKey":"properties.items.[INDEX].type","typeLabel":"string"},"name":{"type":"string","description":"The label or name of the field.","uniqueKey":"properties.items.[INDEX].name","typeLabel":"string"},"help":{"type":"string","description":"Help text displayed with the field.","uniqueKey":"properties.items.[INDEX].help","typeLabel":"string"},"hidden":{"type":"boolean","description":"Whether the field is hidden from view.","uniqueKey":"properties.items.[INDEX].hidden","typeLabel":"boolean"},"required":{"type":"boolean","description":"Whether the field is required.","uniqueKey":"properties.items.[INDEX].required","typeLabel":"boolean"},"placeholder":{"type":"string","description":"Placeholder text for the input.","uniqueKey":"properties.items.[INDEX].placeholder","typeLabel":"string"},"width":{"type":"string","enum":["full","1/2","1/3","2/3","1/4","3/4"],"description":"The width of the block in the form layout.","uniqueKey":"properties.items.[INDEX].width","typeLabel":"enum\u003cstring>"}},"additionalProperties":true,"uniqueKey":"properties.items.[INDEX]","typeLabel":"object"},"uniqueKey":"properties","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":123,"slug":"\u003cstring>","title":"\u003cstring>","visibility":"public","tags":["\u003cstring>"],"language":"\u003cstring>","custom_domain":"\u003cstring>","theme":"default","font_family":"\u003cstring>","color":"\u003cstring>","dark_mode":"light","width":"centered","size":"sm","border_radius":"none","layout_rtl":true,"uppercase_labels":true,"cover_picture":"\u003cstring>","logo_picture":"\u003cstring>","no_branding":true,"transparent_background":true,"submit_button_text":"\u003cstring>","submitted_text":"\u003cstring>","redirect_url":"\u003cstring>","re_fillable":true,"re_fill_button_text":"\u003cstring>","confetti_on_submission":true,"show_progress_bar":true,"submission_retention_value":1825,"submission_retention_unit":"day","closes_at":"2023-11-07T05:31:56Z","closed_text":"\u003cstring>","max_submissions_count":2,"max_submissions_reached_text":"\u003cstring>","auto_save":true,"auto_focus":true,"enable_partial_submissions":true,"editable_submissions":true,"editable_submissions_button_text":"\u003cstring>","password":"\u003cstring>","use_captcha":true,"captcha_provider":"recaptcha","can_be_indexed":true,"seo_meta":{},"custom_code":"\u003cstring>","database_fields_update":["\u003cunknown>"],"properties":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","type":"\u003cstring>","name":"\u003cstring>","help":"\u003cstring>","hidden":true,"required":true,"placeholder":"\u003cstring>","width":"full"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"82f9823a-614f-466f-9759-ac593f413be7":{"description":"Forbidden","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"11b8d462-de37-4371-a06b-226e4168cb4f":{"description":"Not Found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"a65cc977-b4fc-40ba-a870-ba22a619001a":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal Access Token","x-bearer-scopemap":{"workspaces-read":"Read access to workspaces","workspaces-write":"Write access to workspaces","workspace-users-read":"Read access to workspace users","workspace-users-write":"Write access to workspace users","forms-read":"Read access to forms","forms-write":"Write access to forms","manage-integrations":"Manage form integrations (webhooks)"},"scopes":[],"schemeName":"bearerAuth"}}},"servers":{"76717736-54ad-4f96-9ae4-ef1fd42de952":{"url":"https://api.opnform.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Personal Access Token","x-bearer-scopemap":{"workspaces-read":"Read access to workspaces","workspaces-write":"Write access to workspaces","workspace-users-read":"Read access to workspace users","workspace-users-write":"Write access to workspace users","forms-read":"Read access to forms","forms-write":"Write access to forms","manage-integrations":"Manage form integrations (webhooks)"},"scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Personal Access Token","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"opnform","siteName":"OpnForm Technical Docs","title":"Get Form - OpnForm Technical Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-10-28T08:58:45.229Z","originalFileLocation":"api-reference/forms/get-form.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieve a single form.\">\u003cmeta data-mint-head name=\"application-name\" content=\"OpnForm Technical Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/opnform/j_5DxxKW6ps4uqTV/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/opnform/j_5DxxKW6ps4uqTV/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/opnform/j_5DxxKW6ps4uqTV/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/opnform/j_5DxxKW6ps4uqTV/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/opnform/j_5DxxKW6ps4uqTV/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/opnform/j_5DxxKW6ps4uqTV/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/opnform/j_5DxxKW6ps4uqTV/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/opnform/j_5DxxKW6ps4uqTV/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/opnform/j_5DxxKW6ps4uqTV/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Form - OpnForm Technical Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve a single form.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"OpnForm Technical Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.opnform.com/api-reference/forms/get-form\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://opnform.mintlify.app/_mintlify/api/og/v2?division=Forms\u0026amp;title=Get+Form\u0026amp;description=Retrieve+a+single+form.\u0026amp;theme=555c232e9f4f4ee565ee1c66\u0026amp;signature=58c309093a75a3ac49347f23e4acec653e27729245cf39af2147ac446f31dcbb\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get Form - OpnForm Technical Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve a single form.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://opnform.mintlify.app/_mintlify/api/og/v2?division=Forms\u0026amp;title=Get+Form\u0026amp;description=Retrieve+a+single+form.\u0026amp;theme=555c232e9f4f4ee565ee1c66\u0026amp;signature=58c309093a75a3ac49347f23e4acec653e27729245cf39af2147ac446f31dcbb\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/opnform/j_5DxxKW6ps4uqTV/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"OpnForm Technical Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3b82f6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.opnform.com/api-reference/forms/get-form\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/forms/get-form.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.opnform.com/#organization\",\"name\":\"OpnForm Technical Docs\",\"url\":\"https://docs.opnform.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/opnform/OUqYLvFvGemD8lSt/logo.svg?fit=max\u0026auto=format\u0026n=OUqYLvFvGemD8lSt\u0026q=85\u0026s=60c8619bcad52d227a058cc4a5f06955\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.opnform.com#website\",\"name\":\"OpnForm Technical Docs\",\"url\":\"https://docs.opnform.com\",\"publisher\":{\"@id\":\"https://docs.opnform.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.opnform.com/api-reference/forms/get-form#webpage\",\"url\":\"https://docs.opnform.com/api-reference/forms/get-form\",\"name\":\"Get Form\",\"description\":\"Retrieve a single form.\",\"dateModified\":\"2025-10-28T08:58:45.229Z\",\"isPartOf\":{\"@id\":\"https://docs.opnform.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.opnform.com/api-reference/forms/get-form#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.opnform.com/api-reference/forms/get-form#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Forms\",\"item\":\"https://docs.opnform.com/api-reference/forms/list-workspace-forms\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Form\",\"item\":\"https://docs.opnform.com/api-reference/forms/get-form\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.opnform.com/api-reference/forms/get-form#apireference\",\"headline\":\"Get Form\",\"name\":\"Get Form\",\"description\":\"Retrieve a single form.\",\"url\":\"https://docs.opnform.com/api-reference/forms/get-form\",\"mainEntityOfPage\":{\"@id\":\"https://docs.opnform.com/api-reference/forms/get-form#webpage\"},\"dateModified\":\"2025-10-28T08:58:45.229Z\",\"publisher\":{\"@id\":\"https://docs.opnform.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.opnform.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"OpnForm Technical Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"OpnForm Technical Docs","nav":{"global":{"anchors":[{"anchor":"Product Documentation","icon":"book-open-cover","href":"https://help.opnform.com"},{"anchor":"Community","icon":"discord","href":"https://discord.gg/YTSjU2a9TS"},{"anchor":"Changelog","icon":"sparkles","href":"https://feedback.opnform.com/changelog"},{"anchor":"Roadmap","icon":"road","href":"https://feedback.opnform.com/roadmap"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"API Keys","href":"/api-reference/api-keys"},{"title":"Changelog","href":"/api-reference/changelog"}]},{"group":"Workspaces","pages":[{"openapi":"get /open/workspaces","title":"List Workspaces","href":"/api-reference/workspaces/list-workspaces"},{"openapi":"post /open/workspaces/create","title":"Create Workspace","href":"/api-reference/workspaces/create-workspace"},{"openapi":"put /open/workspaces/{workspaceId}","title":"Update Workspace","href":"/api-reference/workspaces/update-workspace"},{"openapi":"delete /open/workspaces/{workspaceId}","title":"Delete Workspace","href":"/api-reference/workspaces/delete-workspace"}]},{"group":"Forms","pages":[{"openapi":"get /open/workspaces/{workspaceId}/forms","title":"List Workspace Forms","href":"/api-reference/forms/list-workspace-forms"},{"openapi":"post /open/forms","title":"Create Form","description":"Create a new form; requires forms-write ability.","href":"/api-reference/forms/create-form"},{"openapi":"get /open/forms/{slug}","title":"Get Form","href":"/api-reference/forms/get-form"},{"openapi":"put /open/forms/{id}","title":"Update Form","description":"Update an existing form. Requires `forms-write`.","href":"/api-reference/forms/update-form"},{"openapi":"delete /open/forms/{id}","title":"Delete Form","href":"/api-reference/forms/delete-form"}]},{"group":"Submissions","pages":[{"openapi":"get /open/forms/{id}/submissions","title":"List Submissions","href":"/api-reference/submissions/list-submissions"},{"openapi":"post /forms/{slug}/answer","title":"Create Submission","href":"/api-reference/submissions/create-submission"},{"openapi":"post /open/forms/{id}/submissions/export","title":"Export Submissions (CSV)","href":"/api-reference/submissions/export-submissions-csv"},{"openapi":"get /open/forms/{id}/submissions/export/status/{job_id}","title":"Check Export Status","href":"/api-reference/submissions/export-status"},{"openapi":"put /open/forms/{id}/submissions/{submission_id}","title":"Update Submission","href":"/api-reference/submissions/update-submission"},{"openapi":"delete /open/forms/{id}/submissions/{submission_id}","title":"Delete Submission","href":"/api-reference/submissions/delete-submission"}]},{"group":"Integrations","pages":[{"openapi":"get /open/forms/{form}/integrations","title":"List Form Integrations","href":"/api-reference/integrations/list-form-integrations"},{"openapi":"post /open/forms/{form}/integrations","title":"Create Webhook Integration","href":"/api-reference/integrations/create-webhook-integration"},{"openapi":"put /open/forms/{form}/integrations/{integrationid}","title":"Update Webhook Integration","href":"/api-reference/integrations/update-webhook-integration"},{"openapi":"delete /open/forms/{form}/integrations/{integrationid}","title":"Delete Webhook Integration","href":"/api-reference/integrations/delete-webhook-integration"},{"title":"List Integration Events","openapi":"get /open/forms/{form}/integrations/{integrationid}/events","href":"/api-reference/integrations/list-webhook-events"},{"title":"Retry an Integration Event","openapi":"post /open/forms/{form}/integrations/{integrationid}/events/{event}/retry","href":"/api-reference/integrations/retry-integration-event"},{"title":"Validating Webhook Signatures","href":"/api-reference/integrations/webhook-security"}]},{"group":"Workspace Users","pages":[{"openapi":"get /open/workspaces/{workspaceId}/users","title":"List Workspace Users","href":"/api-reference/workspace-users/list-workspace-users"},{"openapi":"get /open/workspaces/{workspaceId}/invites","title":"List Workspace Invites","href":"/api-reference/workspace-users/list-workspace-invites"},{"openapi":"post /open/workspaces/{workspaceId}/users/add","title":"Add Workspace User","href":"/api-reference/workspace-users/add-workspace-user"},{"openapi":"delete /open/workspaces/{workspaceId}/users/{userId}/remove","title":"Remove Workspace User","href":"/api-reference/workspace-users/remove-workspace-user"},{"openapi":"put /open/workspaces/{workspaceId}/users/{userId}/update-role","title":"Update Workspace User Role","href":"/api-reference/workspace-users/update-workspace-user-role"},{"openapi":"post /open/workspaces/{workspaceId}/leave","title":"Leave Workspace","href":"/api-reference/workspace-users/leave-workspace"},{"openapi":"post /open/workspaces/{workspaceId}/invites/{inviteId}/resend","title":"Resend Workspace Invite","href":"/api-reference/workspace-users/resend-workspace-invite"},{"openapi":"delete /open/workspaces/{workspaceId}/invites/{inviteId}/cancel","title":"Cancel Workspace Invite","href":"/api-reference/workspace-users/cancel-workspace-invite"}]},{"group":"Zapier","pages":[{"openapi":"get /external/zapier/validate","title":"Validate API Key","href":"/api-reference/zapier/validate-api-key"},{"openapi":"get /external/zapier/forms","title":"List Forms","href":"/api-reference/zapier/list-forms"},{"openapi":"post /external/zapier/webhook","title":"New Submission Trigger","href":"/api-reference/zapier/new-submission-trigger"},{"openapi":"delete /external/zapier/webhook","title":"Unsubscribe Webhook","href":"/api-reference/zapier/unsubscribe-webhook"},{"openapi":"get /external/zapier/submissions/recent","title":"Sample Submission Polling","href":"/api-reference/zapier/sample-submission-polling"}]}]},{"tab":"Contributing","pages":[{"title":"Contributing","href":"/contributing/getting-started"}]}]},"basePath":"","title":"Get Form - OpnForm Technical Docs","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","Page-Buji1S4J.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","clsx-B2v50t8t.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DJnKvr0g.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BHrrjR1K.js"]}