Retrieve Form Definition by ID
curl --request GET \
--url https://{base-address}/apis/setting-service/public/v1/forms/{form_id}import requests
url = "https://{base-address}/apis/setting-service/public/v1/forms/{form_id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://{base-address}/apis/setting-service/public/v1/forms/{form_id}', 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://{base-address}/apis/setting-service/public/v1/forms/{form_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://{base-address}/apis/setting-service/public/v1/forms/{form_id}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{base-address}/apis/setting-service/public/v1/forms/{form_id}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{base-address}/apis/setting-service/public/v1/forms/{form_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"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"
}
}
}{
"Status": "failure",
"Data": {
"Status": "failure",
"Error": {
"message": "<string>",
"name": "<string>",
"code": "<string>"
}
}
}{
"Status": "failure",
"Data": {
"Status": "failure",
"Error": {
"message": "<string>",
"name": "<string>",
"code": "<string>"
}
}
}{
"Status": "failure",
"Data": {
"Status": "failure",
"Error": {
"message": "<string>",
"name": "<string>",
"code": "<string>"
}
}
}Form APIs
Get Form By ID
Fetch the full configuration and metadata for a form, including its fields, layout hierarchy, validation rules, and submission settings. Use this endpoint to dynamically render form UIs or integrate with form builders at runtime.
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}import requests
url = "https://{base-address}/apis/setting-service/public/v1/forms/{form_id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://{base-address}/apis/setting-service/public/v1/forms/{form_id}', 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://{base-address}/apis/setting-service/public/v1/forms/{form_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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://{base-address}/apis/setting-service/public/v1/forms/{form_id}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{base-address}/apis/setting-service/public/v1/forms/{form_id}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{base-address}/apis/setting-service/public/v1/forms/{form_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"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"
}
}
}{
"Status": "failure",
"Data": {
"Status": "failure",
"Error": {
"message": "<string>",
"name": "<string>",
"code": "<string>"
}
}
}{
"Status": "failure",
"Data": {
"Status": "failure",
"Error": {
"message": "<string>",
"name": "<string>",
"code": "<string>"
}
}
}{
"Status": "failure",
"Data": {
"Status": "failure",
"Error": {
"message": "<string>",
"name": "<string>",
"code": "<string>"
}
}
}Before calling this endpoint, make sure you’ve generated an API token and picked the correct domain. See Authentication & Base URLs.
Path Parameters
Unique identifier of the form to retrieve.
Query Parameters
Comma-separated list of fields to include in the response
Specifies the language or region for the response data
⌘I