GET
/
apis
/
setting-service
/
public
/
v1
/
forms
/
{form_id}
Retrieve Form Definition by ID
curl --request GET \
  --url https://{base-address}/apis/setting-service/public/v1/forms/{form_id}
{
  "Status": "success",
  "Data": {
    "item": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "display_name": "<string>",
      "description": "<string>",
      "form_type": "<string>",
      "form_builder": [
        {
          "id": "<string>",
          "type": "<string>",
          "name": "<string>",
          "properties": {},
          "children": [
            {}
          ]
        }
      ],
      "submit_btn_txt": "<string>",
      "is_captcha_enabled": true,
      "success_action": {
        "redirect": "<string>"
      },
      "webhook": "<string>",
      "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "modified_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "modified_at": "2023-11-07T05:31:56Z",
      "form_media_base_folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "form_media_folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  }
}
Before calling this endpoint, make sure you’ve generated an API token and picked the correct domain. See Authentication & Base URLs.

Path Parameters

​
form_id
string
required

Unique identifier of the form to retrieve.

Query Parameters

​
fields
string
required

Comma-separated list of fields to include in the response

​
locale
string
required

Specifies the language or region for the response data

Response

200
application/json

Form configuration and metadata returned successfully.

The response is of type object.