GET
/
forms
/
{formId}
curl --request GET \
  --url https://app.formbox.app/api/v1/forms/{formId} \
  --header 'api-key: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "type": "<string>",
  "submissionStorageDuration": "<string>",
  "sendEmailNotifications": true,
  "sendRespondantEmailNotifications": true,
  "emailsToNotify": [
    "<string>"
  ],
  "allowedDomains": "<string>",
  "customHoneypot": "<string>",
  "limitResponses": true,
  "maxResponses": 123,
  "respondantEmailFromName": "<string>",
  "respondantEmailSubject": "<string>",
  "respondantEmailMessageHTML": "<string>",
  "submitButtonText": "<string>",
  "webhookEnabled": true,
  "webhookUrl": "<string>",
  "useCustomRedirect": true,
  "customSuccessUrl": "<string>",
  "useCustomThankYouPage": true,
  "tpBackgroundColor": "<string>",
  "tpTextColor": "<string>",
  "tpButtonBackgroundColor": "<string>",
  "tpButtonColor": "<string>",
  "tpHeader": "<string>",
  "tpMessage": "<string>",
  "tpButtonText": "<string>",
  "tpButtonUrl": "<string>",
  "googleRecaptchaEnabled": true,
  "googleRecaptchaSecretKey": "<string>",
  "showCustomClosedMessage": true,
  "closeMessageTitle": "<string>",
  "closeMessageDescription": "<string>",
  "headerTitle": "<string>",
  "headerDescription": "<string>",
  "pageMode": "compact",
  "backgroundColor": "<string>",
  "textColor": "<string>",
  "buttonBackgroundColor": "<string>",
  "buttonTextColor": "<string>",
  "accentColor": "<string>",
  "buttonBorderStyle": "full",
  "inputBorderStyle": "full",
  "headerImage": "<string>",
  "logo": "<string>",
  "fields": [
    {
      "id": "<string>",
      "label": "<string>",
      "description": "<string>",
      "type": "<string>",
      "subtype": "<string>",
      "required": true,
      "ratingCount": 123,
      "options": [
        {
          "id": "<string>",
          "value": "<string>"
        }
      ],
      "showDescription": true
    }
  ],
  "removeFormboxBranding": true,
  "isClosed": true,
  "orgId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Headers

api-key
string
required

The API key.

Path Parameters

formId
string
required

The unique ID of the form to retrieve.

Example:

"clux0rgak00011..."

Response

200
application/json

A specific form.

The response is of type object.