{"id":2767,"date":"2013-02-13T14:54:52","date_gmt":"2013-02-13T14:54:52","guid":{"rendered":"http:\/\/www.123formbuilder.com\/docs\/?p=2767"},"modified":"2022-11-15T13:30:12","modified_gmt":"2022-11-15T13:30:12","slug":"apidocumentation","status":"publish","type":"post","link":"https:\/\/www.123formbuilder.com\/docs\/apidocumentation\/","title":{"rendered":"123FormBuilder API"},"content":{"rendered":"\n<div class=\"warningBox\"><span style=\"font-size: 16px\"><p><b>Important Note <\/b><\/p> This version of the API was deprecated. If you still need to automate your data collection processes, and retrieve collected data or make various operations related to your 123FormBuilder account through API calls, you can use our new and improved API v2. Please visit <a href=\"https:\/\/developer.123formbuilder.com\/\"> our developer documentation <\/a> for more details.<\/span><\/div>\n\n\n\n<div style=\"height:15px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<p>The 123FormBuilder API is built mainly for programmers who want to retrieve data from their <a href=\"\/\">form builder<\/a> accounts and, implicitly, from their forms.<\/p>\n\n\n\n<p>An API call consists of performing a cURL GET operation on the desired API page. There are also additional parameters that have to be sent through cURL POST. All parameters are presented below.<\/p>\n\n\n\n<p>There are 2 available output formats: XML and JSON. In case of an error, the appropriate message is displayed under a tag or key.<\/p>\n\n\n\n<p>Browse our&nbsp;<a href=\"https:\/\/developer.123formbuilder.com\/\">knowledge base for developers <\/a>for more information.<\/p>\n\n\n\n<p>You must use the HTTPS protocol for all the API URLs in your script. That doesn&#8217;t mean that the URL of your script must also start with <b>https:\/\/<\/b><\/p>\n\n\n\n<hr class=\"wp-block-separator has-css-opacity is-style-wide\" \/>\n\n\n\n<h2 class=\"wp-block-heading\" id=\"h-parameters\"><strong>Parameters<\/strong><\/h2>\n\n\n\n<p>The most important POST parameter is <b>apiKey<\/b>. This is required for any API call. You can find your API key in the <b>My Account<\/b> \u2192 <b>API Keys<\/b> section of your 123FormBuilder account.<\/p>\n\n\n\n<p>To add the API key to your URL, at the end of the link add <b>?apiKey={YOUR API KEY}<\/b>.<br><br>Here is an example:<\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">https:\/\/app.123formbuilder.com\/api\/forms\/{form-id}\/submissions.{xml\/json}?apiKey=xxxxxx-xxxxxx-xxxxxxxxx<\/pre>\n\n\n\n<p>The API provides the following operations:<\/p>\n\n\n\n<ul class=\"wp-block-list\"><li><a href=\"https:\/\/www.123formbuilder.com\/docs\/123formbuilder-api-retrieve-forms\/\">Retrieve Forms<\/a><\/li><li><a href=\"https:\/\/www.123formbuilder.com\/docs\/123formbuilder-api-retrieve-fields\/\">Retrieve Fields<\/a><\/li><li><a href=\"https:\/\/www.123formbuilder.com\/docs\/123formbuilder-api-post-webhook\/\">POST Webhook<\/a><\/li><li><a href=\"https:\/\/www.123formbuilder.com\/docs\/123formbuilder-api-retrieve-submissions\/\">Retrieve Submissions<\/a><\/li><li><a href=\"https:\/\/www.123formbuilder.com\/docs\/123formbuilder-api-retrieve-submissions-count\/\">Retrieve Submissions Count<\/a><\/li><\/ul>\n\n\n\n<p>Use the links above to find out more about each action. As for the <b>API Responses<\/b> received when using our API Key, consider reading <a href=\"https:\/\/www.123formbuilder.com\/docs\/api-responses\/\">this article<\/a>.<\/p>\n\n\n\n<p>A <a href=\"https:\/\/www.123formbuilder.com\/docs\/free-plan-features\/\">Basic<\/a> free account can perform up to 100 API calls per day. For unlimited API calls\/day, check our <a href=\"https:\/\/www.123formbuilder.com\/docs\/gold-plan-features\/\">Gold<\/a>, <a href=\"https:\/\/www.123formbuilder.com\/docs\/platinum-plan-features\/\">Platinum<\/a>, and <a href=\"https:\/\/www.123formbuilder.com\/docs\/diamond-plan-features\/\">Diamond<\/a> subscriptions.<\/p>\n\n\n\n<p>For more advanced capabilities, we highly recommend you to use&nbsp;<a href=\"https:\/\/developer.123formbuilder.com\/api-v2\/\">API V2<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Important Note This version of the API was deprecated. If you still need to automate your data collection processes, and retrieve collected data or make various operations related to your 123FormBuilder account through API calls, you can use our new and improved API v2. Please visit our developer documentation for more details. The 123FormBuilder API [&hellip;]<\/p>\n","protected":false},"author":13,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"inline_featured_image":false,"footnotes":""},"categories":[1],"tags":[],"class_list":["post-2767","post","type-post","status-publish","format-standard","hentry","category-uncategorized"],"yoast_head":"<!-- This site is optimized with the Yoast SEO Premium plugin v24.2 (Yoast SEO v27.2) - https:\/\/yoast.com\/product\/yoast-seo-premium-wordpress\/ -->\n<title>The 123FormBuilder API | Knowledge Base 101<\/title>\n<meta name=\"description\" content=\"Read our knowledge base article about the 123FormBuilder API and how you can use it with your online forms.\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.123formbuilder.com\/docs\/apidocumentation\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"123FormBuilder API\" \/>\n<meta property=\"og:description\" content=\"Read our knowledge base article about the 123FormBuilder API and how you can use it with your online forms.\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.123formbuilder.com\/docs\/apidocumentation\/\" \/>\n<meta property=\"og:site_name\" content=\"123FormBuilder Knowledge Base\" \/>\n<meta property=\"article:published_time\" content=\"2013-02-13T14:54:52+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2022-11-15T13:30:12+00:00\" \/>\n<meta name=\"author\" content=\"admin\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"admin\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"2 minutes\" \/>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"The 123FormBuilder API | Knowledge Base 101","description":"Read our knowledge base article about the 123FormBuilder API and how you can use it with your online forms.","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.123formbuilder.com\/docs\/apidocumentation\/","og_locale":"en_US","og_type":"article","og_title":"123FormBuilder API","og_description":"Read our knowledge base article about the 123FormBuilder API and how you can use it with your online forms.","og_url":"https:\/\/www.123formbuilder.com\/docs\/apidocumentation\/","og_site_name":"123FormBuilder Knowledge Base","article_published_time":"2013-02-13T14:54:52+00:00","article_modified_time":"2022-11-15T13:30:12+00:00","author":"admin","twitter_card":"summary_large_image","twitter_misc":{"Written by":"admin","Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/www.123formbuilder.com\/docs\/apidocumentation\/#article","isPartOf":{"@id":"https:\/\/www.123formbuilder.com\/docs\/apidocumentation\/"},"author":{"name":"admin","@id":"https:\/\/www.123formbuilder.com\/docs\/#\/schema\/person\/ac765b93d6689ec0f4ee6f6e040d66ea"},"headline":"123FormBuilder API","datePublished":"2013-02-13T14:54:52+00:00","dateModified":"2022-11-15T13:30:12+00:00","mainEntityOfPage":{"@id":"https:\/\/www.123formbuilder.com\/docs\/apidocumentation\/"},"wordCount":307,"commentCount":6,"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/www.123formbuilder.com\/docs\/apidocumentation\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/www.123formbuilder.com\/docs\/apidocumentation\/","url":"https:\/\/www.123formbuilder.com\/docs\/apidocumentation\/","name":"The 123FormBuilder API | Knowledge Base 101","isPartOf":{"@id":"https:\/\/www.123formbuilder.com\/docs\/#website"},"datePublished":"2013-02-13T14:54:52+00:00","dateModified":"2022-11-15T13:30:12+00:00","author":{"@id":"https:\/\/www.123formbuilder.com\/docs\/#\/schema\/person\/ac765b93d6689ec0f4ee6f6e040d66ea"},"description":"Read our knowledge base article about the 123FormBuilder API and how you can use it with your online forms.","breadcrumb":{"@id":"https:\/\/www.123formbuilder.com\/docs\/apidocumentation\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.123formbuilder.com\/docs\/apidocumentation\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.123formbuilder.com\/docs\/apidocumentation\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.123formbuilder.com\/docs\/"},{"@type":"ListItem","position":2,"name":"123FormBuilder API"}]},{"@type":"WebSite","@id":"https:\/\/www.123formbuilder.com\/docs\/#website","url":"https:\/\/www.123formbuilder.com\/docs\/","name":"123FormBuilder Knowledge Base","description":"Search our documentation platform for answers, service specifications and 3rd-party integrations.","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.123formbuilder.com\/docs\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Person","@id":"https:\/\/www.123formbuilder.com\/docs\/#\/schema\/person\/ac765b93d6689ec0f4ee6f6e040d66ea","name":"admin","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/secure.gravatar.com\/avatar\/41383a571ede8f1257b128aa53a410cc1ea4c1901ac8cea3776cba5438d24843?s=96&d=https%3A%2F%2Fui-avatars.com%2Fapi%2Fadmin%2F96%2Ff3f3f3%2Faaa%2F1%2F0.5%2Ffalse%2Ftrue&r=g","url":"https:\/\/secure.gravatar.com\/avatar\/41383a571ede8f1257b128aa53a410cc1ea4c1901ac8cea3776cba5438d24843?s=96&d=https%3A%2F%2Fui-avatars.com%2Fapi%2Fadmin%2F96%2Ff3f3f3%2Faaa%2F1%2F0.5%2Ffalse%2Ftrue&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/41383a571ede8f1257b128aa53a410cc1ea4c1901ac8cea3776cba5438d24843?s=96&d=https%3A%2F%2Fui-avatars.com%2Fapi%2Fadmin%2F96%2Ff3f3f3%2Faaa%2F1%2F0.5%2Ffalse%2Ftrue&r=g","caption":"admin"},"url":"https:\/\/www.123formbuilder.com\/docs\/author\/admin\/"}]}},"_links":{"self":[{"href":"https:\/\/www.123formbuilder.com\/docs\/wp-json\/wp\/v2\/posts\/2767","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.123formbuilder.com\/docs\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.123formbuilder.com\/docs\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.123formbuilder.com\/docs\/wp-json\/wp\/v2\/users\/13"}],"replies":[{"embeddable":true,"href":"https:\/\/www.123formbuilder.com\/docs\/wp-json\/wp\/v2\/comments?post=2767"}],"version-history":[{"count":68,"href":"https:\/\/www.123formbuilder.com\/docs\/wp-json\/wp\/v2\/posts\/2767\/revisions"}],"predecessor-version":[{"id":45542,"href":"https:\/\/www.123formbuilder.com\/docs\/wp-json\/wp\/v2\/posts\/2767\/revisions\/45542"}],"wp:attachment":[{"href":"https:\/\/www.123formbuilder.com\/docs\/wp-json\/wp\/v2\/media?parent=2767"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.123formbuilder.com\/docs\/wp-json\/wp\/v2\/categories?post=2767"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.123formbuilder.com\/docs\/wp-json\/wp\/v2\/tags?post=2767"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}