Skip to main content

Get Form Configuration

Overview

Fetch the configuration and enabled features for a specific form using its formId.
This API returns form settings like email, templates, captcha, and feature entitlements.
Useful for frontend apps to dynamically render form behavior.


Endpoint

GET /api/forms/{formId}/config


Request

Path Params

ParamTypeRequiredDescription
formIdstring✅ YesUnique form ID

Headers

HeaderTypeRequiredDescription
Authorizationstring✅ YesBearer INTERNAL_PROVISION_TOKEN

Response

Success (200)

{
"form_id": "abc123",
"settings": {
"form_name": "Contact Form",
"email": "[email protected]",
"redirect_url": "https://example.com/success",
"template": "cloudmysite",
"custom_template_Html": "",
"file_upload": false,
"turnstile": {
"enabled": true,
"type": "turnstile",
"site_key": ""
},
"honeypot": true,
"google_sheets": false
},
"entitlements": {
"plan": "free",
"features": {
"file_upload": false,
"google_sheets": false,
"ai_template": false,
"honeypot": true,
"turnstile": true
}
}
}

Error Responses

401 - Unauthorized
{
"message": "Unauthorized"
}
404 - Form Not Found
{
"message": "Form not found"
}
500 - Internal Server Error
{
"message": "Internal server error"
}

cURL Example

curl -X GET "https://api.cloudmysite.com/forms/api/forms/{formId}/config" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <INTERNAL_PROVISION_TOKEN>"

Notes

  • Requires valid INTERNAL_PROVISION_TOKEN in Authorization header
  • Token is used to protect the API from unauthorized access (only trusted/internal services should use it)
  • Always returns feature availability under entitlements
  • Defaults to free plan if not set