{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Quick start","description":"Build integrations, automate workflows, and manage forms and responses programmatically with the forms.app API.","siteUrl":"https://developers.forms.app","image":"/assets/formsapp-developer-docs.6ffba4f5ff7d394698661bcdb0ed2a8452f27acaf4e82754e5d0f4109563471c.9c1bb791.png","lang":"en-US","projectTitle":"forms.app Developer Docs","llmstxt":{"sections":[{"title":"llmtxt for forms app documents","includeFiles":["**/*"],"excludeFiles":[]}]},"jsonLd":{"@context":"https://schema.org","@type":"Organization","additionalType":"https://en.wikipedia.org/wiki/Software_as_a_service","url":"https://forms.app","name":"forms.app","logo":"https://cdn.forms.app/icons/all/brands/formsapp-logo-dark.svg","description":"forms.app is a free online form builder designed for teams. forms.app offers a modern, easy-to-use form builder and allows unlimited responses and team members.","foundingDate":"2018","sameAs":"https://linkedin.com/company/formsapp","contactPoint":{"@type":"ContactPoint","contactType":"Customer service","email":"support@forms.app","url":"https://forms.app/en/contact-us"}}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"quick-start","__idx":0},"children":["Quick start"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This guide walks you through creating an API key and listing the forms in your account."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"before-you-begin","__idx":1},"children":["Before you begin"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In order to start building, you need to get a forms.app API from your account settings and see how to make a request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All requests go to:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://api.forms.app\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-1-create-an-api-key","__idx":2},"children":["Step 1: Create an API key"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Log in to ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://forms.app"},"children":["forms.app"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click your avatar in the top-right corner and open ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Account Settings"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Go to the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Keys"]}," tab."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create API Key"]},", enter a descriptive name (for example, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Production sync"]},"), and confirm."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Copy the generated key immediately; it is shown ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["only once"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Store it securely, such as in an environment variable or secret manager."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can create multiple keys (one per integration) and revoke any of them from the same ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Keys"]}," page."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-2-make-your-first-request","__idx":3},"children":["Step 2: Make your first request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["List every form in your account with a single GET request. Pass your API key in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Api-Key"]}," header:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -s https://api.forms.app/v1/form \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Replace ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["YOUR_API_KEY"]}," with the key you copied in step 1."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-response","__idx":4},"children":["Example response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"success\": true,\n  \"data\": [\n    {\n      \"_id\": \"64f1a2b3c4d5e6f7a8b9c0d1\",\n      \"title\": \"Customer feedback\"\n    },\n    {\n      \"_id\": \"64f1a2b3c4d5e6f7a8b9c0d2\",\n      \"title\": \"Event registration\"\n    }\n  ],\n  \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each item includes the form's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["_id"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["title"]},". Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["_id"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/form/{id}"]}," to retrieve the full form structure."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"step-3-inspect-a-single-form","__idx":5},"children":["Step 3: Inspect a single form"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Pick an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["_id"]}," from the list above and fetch the complete form:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -s https://api.forms.app/v1/form/64f1a2b3c4d5e6f7a8b9c0d1 \\\n  -H \"X-Api-Key: YOUR_API_KEY\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response includes questions, design settings, thank-you pages, and more. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/tutorials/fetching-forms"},"children":["Fetching forms"]}," for a guided walkthrough."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"whats-next","__idx":6},"children":["What's next?"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Read ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/the-essentials"},"children":["The essentials"]}," for authentication options, the response envelope, and rate limiting."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Follow ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/tutorials/fetching-submissions"},"children":["Fetching submissions"]}," to page through form answers."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Browse the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis"},"children":["API reference"]}," for every endpoint and schema."]}]}]},"headings":[{"value":"Quick start","id":"quick-start","depth":1},{"value":"Before you begin","id":"before-you-begin","depth":2},{"value":"Step 1: Create an API key","id":"step-1-create-an-api-key","depth":2},{"value":"Step 2: Make your first request","id":"step-2-make-your-first-request","depth":2},{"value":"Example response","id":"example-response","depth":3},{"value":"Step 3: Inspect a single form","id":"step-3-inspect-a-single-form","depth":2},{"value":"What's next?","id":"whats-next","depth":2}],"frontmatter":{"seo":{"title":"Quick start"}},"lastModified":"2026-06-22T14:59:37.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/quickstart","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}