How to list custom fields using BoldSign API?
BoldSign allows you to retrieve a complete list of custom fields linked to a specific brand using the brand ID via API. The list provides a detailed view of the custom fields within the brand, including information such as fieldID, name, description and order, of the form fields.
Below are examples codes of how to get a list of the created custom in a particluar brand :
Code snippet
curl --location 'https://api.boldsign.com/v1/customField/list?brandId={brandId}' \
--header 'Accept: application/json' \
-H 'X-API-KEY: {your api key}' \
var apiClient = new ApiClient("https://api.boldsign.com", "{api key}");
var customFieldClient = new CustomFieldClient(apiClient);
var brandId = "{brand id}";
var customFields = await customFieldClient.GetBrandBasedCustomFieldsAsync(brandId);
//var customField
Console.WriteLine(customFields);
import requests
url = "https://api.boldsign.com/v1/customField/list?brandId={brandId}"
payload = {}
headers = {
'Accept': 'application/json',
"X-API-KEY": "{your api key}"
}
response = requests.request("DELETE", url, headers=headers, data=payload)
print(response.text)
const axios = require('axios');
let config = {
method: 'delete',
maxBodyLength: Infinity,
url: 'https://api.boldsign.com/v1/customField/list?brandId={brandId}',
headers: {
'Accept': 'application/json',
'X-API-KEY': '{your api key}'
}
};
axios.request(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
<?php
require 'vendor/autoload.php';
use GuzzleHttp\Client;
use GuzzleHttp\Exception\RequestException;
$client = new GuzzleHttp\Client([ 'verify' => false, ]);
$apiKey = 'your_actual_api_key';
$customFieldId = 'your_custom_field_id';
$headers = [
'Accept': 'application/json',
'X-API-KEY' => $apiKey,
];
$request = new Request('GET', 'https://api.boldsign.com/v1/customField/list?brandId={brandId}', $headers);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
In the provided code example, make sure to replace values for brandId with the ID of the brand you want to list the custom fields from. Once the codes are executed, all the custom fields under the specified brand will be listed.