Retrieve a form
curl --request GET \
--url https://app.formbox.app/api/v1/forms/{formId} \
--header 'api-key: <api-key>'import requests
url = "https://app.formbox.app/api/v1/forms/{formId}"
headers = {"api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'api-key': '<api-key>'}};
fetch('https://app.formbox.app/api/v1/forms/{formId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.formbox.app/api/v1/forms/{formId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.formbox.app/api/v1/forms/{formId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.formbox.app/api/v1/forms/{formId}")
.header("api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.formbox.app/api/v1/forms/{formId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"organizationId": "<string>",
"removeFormboxBranding": true,
"sendEmailNotifications": true,
"emailsToNotify": [
"<string>"
],
"submissionStorageDuration": "<string>",
"sendRespondentEmailNotifications": true,
"respondentEmailFromName": "<string>",
"respondentEmailSubject": "<string>",
"respondentEmailMessageHTML": "<string>",
"submitButtonText": "<string>",
"limitResponses": true,
"isClosed": true,
"autoCloseEnabled": true,
"autoCloseDate": "<string>",
"autoCloseTime": "<string>",
"autoCloseTimezone": "<string>",
"maxResponses": 123,
"useCustomRedirect": true,
"customSuccessUrl": "<string>",
"webhookEnabled": true,
"webhookUrl": "<string>",
"customHoneypot": "<string>",
"googleRecaptchaEnabled": true,
"allowedDomains": "<string>",
"allowedCountries": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"type": "endpoint",
"fields": [
{
"id": "<string>",
"label": "<string>",
"type": "<string>",
"subtype": "<string>",
"required": true,
"showDescription": true,
"description": "<string>",
"placeholder": "<string>",
"minLength": 123,
"maxLength": 123,
"minValue": 123,
"maxValue": 123,
"ratingCount": 123,
"scaleMin": 123,
"scaleMax": 123,
"minLabel": "<string>",
"maxLabel": "<string>",
"options": [
{
"id": "<string>",
"value": "<string>"
}
],
"logic": {
"rules": [
{
"id": "<string>",
"action": "show_field",
"when": {
"combinator": "all",
"conditions": [
{
"id": "<string>",
"sourceFieldId": "<string>",
"operator": "is_empty",
"value": "<string>"
}
]
},
"targetFieldId": "<string>",
"targetFieldIds": [
"<string>"
],
"targetPageId": "<string>"
}
]
}
}
],
"accentColor": "<string>",
"backgroundColor": "<string>",
"buttonBackgroundColor": "<string>",
"buttonBorderStyle": "full",
"buttonTextColor": "<string>",
"closeMessageDescription": "<string>",
"closeMessageTitle": "<string>",
"headerDescription": "<string>",
"headerImage": "<string>",
"headerTitle": "<string>",
"seoDescription": "<string>",
"seoImage": "<string>",
"seoTitle": "<string>",
"inputBorderStyle": "full",
"logo": "<string>",
"pageMode": "compact",
"saveAnswers": true,
"allowMultipleSubmissions": true,
"showCustomClosedMessage": true,
"textColor": "<string>",
"tpBackgroundColor": "<string>",
"tpButtonColor": "<string>",
"tpButtonText": "<string>",
"tpButtonUrl": "<string>",
"tpHeader": "<string>",
"tpMessage": "<string>",
"tpTextColor": "<string>",
"useCustomThankYouPage": true,
"tpButtonBackgroundColor": "<string>",
"ipBlacklist": "<string>",
"imageCompressionType": [
"webp"
],
"disableEmailDataCensoring": true
}{
"error": {
"code": "unauthorized",
"message": "No API key provided. Pass your API key in the api-key header."
}
}{
"error": {
"code": "forbidden",
"message": "Your API key requires read or full access scope to retrieve a form."
}
}{
"error": {
"code": "not_found",
"message": "No form with this ID exists in your organization. Check that the formId is correct and belongs to the organization associated with your API key."
}
}{
"error": {
"code": "unprocessable_entity",
"message": "The request was well-formed but contained semantic errors."
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "Too many requests. Please slow down and try again shortly."
}
}{
"error": {
"code": "internal_server_error",
"message": "An internal server error occurred. Please contact support if the problem persists."
}
}Forms
Retrieve a form
Retrieve a specific form for the authenticated organization.
GET
/
forms
/
{formId}
Retrieve a form
curl --request GET \
--url https://app.formbox.app/api/v1/forms/{formId} \
--header 'api-key: <api-key>'import requests
url = "https://app.formbox.app/api/v1/forms/{formId}"
headers = {"api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'api-key': '<api-key>'}};
fetch('https://app.formbox.app/api/v1/forms/{formId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.formbox.app/api/v1/forms/{formId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.formbox.app/api/v1/forms/{formId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.formbox.app/api/v1/forms/{formId}")
.header("api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.formbox.app/api/v1/forms/{formId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"organizationId": "<string>",
"removeFormboxBranding": true,
"sendEmailNotifications": true,
"emailsToNotify": [
"<string>"
],
"submissionStorageDuration": "<string>",
"sendRespondentEmailNotifications": true,
"respondentEmailFromName": "<string>",
"respondentEmailSubject": "<string>",
"respondentEmailMessageHTML": "<string>",
"submitButtonText": "<string>",
"limitResponses": true,
"isClosed": true,
"autoCloseEnabled": true,
"autoCloseDate": "<string>",
"autoCloseTime": "<string>",
"autoCloseTimezone": "<string>",
"maxResponses": 123,
"useCustomRedirect": true,
"customSuccessUrl": "<string>",
"webhookEnabled": true,
"webhookUrl": "<string>",
"customHoneypot": "<string>",
"googleRecaptchaEnabled": true,
"allowedDomains": "<string>",
"allowedCountries": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"type": "endpoint",
"fields": [
{
"id": "<string>",
"label": "<string>",
"type": "<string>",
"subtype": "<string>",
"required": true,
"showDescription": true,
"description": "<string>",
"placeholder": "<string>",
"minLength": 123,
"maxLength": 123,
"minValue": 123,
"maxValue": 123,
"ratingCount": 123,
"scaleMin": 123,
"scaleMax": 123,
"minLabel": "<string>",
"maxLabel": "<string>",
"options": [
{
"id": "<string>",
"value": "<string>"
}
],
"logic": {
"rules": [
{
"id": "<string>",
"action": "show_field",
"when": {
"combinator": "all",
"conditions": [
{
"id": "<string>",
"sourceFieldId": "<string>",
"operator": "is_empty",
"value": "<string>"
}
]
},
"targetFieldId": "<string>",
"targetFieldIds": [
"<string>"
],
"targetPageId": "<string>"
}
]
}
}
],
"accentColor": "<string>",
"backgroundColor": "<string>",
"buttonBackgroundColor": "<string>",
"buttonBorderStyle": "full",
"buttonTextColor": "<string>",
"closeMessageDescription": "<string>",
"closeMessageTitle": "<string>",
"headerDescription": "<string>",
"headerImage": "<string>",
"headerTitle": "<string>",
"seoDescription": "<string>",
"seoImage": "<string>",
"seoTitle": "<string>",
"inputBorderStyle": "full",
"logo": "<string>",
"pageMode": "compact",
"saveAnswers": true,
"allowMultipleSubmissions": true,
"showCustomClosedMessage": true,
"textColor": "<string>",
"tpBackgroundColor": "<string>",
"tpButtonColor": "<string>",
"tpButtonText": "<string>",
"tpButtonUrl": "<string>",
"tpHeader": "<string>",
"tpMessage": "<string>",
"tpTextColor": "<string>",
"useCustomThankYouPage": true,
"tpButtonBackgroundColor": "<string>",
"ipBlacklist": "<string>",
"imageCompressionType": [
"webp"
],
"disableEmailDataCensoring": true
}{
"error": {
"code": "unauthorized",
"message": "No API key provided. Pass your API key in the api-key header."
}
}{
"error": {
"code": "forbidden",
"message": "Your API key requires read or full access scope to retrieve a form."
}
}{
"error": {
"code": "not_found",
"message": "No form with this ID exists in your organization. Check that the formId is correct and belongs to the organization associated with your API key."
}
}{
"error": {
"code": "unprocessable_entity",
"message": "The request was well-formed but contained semantic errors."
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "Too many requests. Please slow down and try again shortly."
}
}{
"error": {
"code": "internal_server_error",
"message": "An internal server error occurred. Please contact support if the problem persists."
}
}Response
A specific form.
Last modified on April 1, 2026