List custom fields
get/v1/customField/listThis API retrieves a list of all custom fields associated with a specific brand, identified by the brand ID. It provides users with a comprehensive overview of their custom field inventory within the brand, including field IDs, names, descriptions, order, and form field.
Code snippet
curl --location 'https://api.boldsign.com/v1/customField/list?brandId={brandId}' \
--header 'Accept: application/json' \
--header 'Authorization: {{apiKey}}'
var apiClient = new ApiClient("https://api.boldsign.com", "Your_API_Key");
var customFieldClient = new CustomFieldClient(apiClient);
var customFieldCollection = customFieldClient.GetBrandBasedCustomFields("YOUR_BRAND_ID");
import boldsign
configuration = boldsign.Configuration(api_key="YOUR_API_KEY")
with boldsign.ApiClient(configuration) as api_client:
custom_field_api = boldsign.CustomFieldApi(api_client)
custom_field_collection = custom_field_api.custom_fields_list(brand_id="YOUR_BRAND_ID")
<?php require_once "vendor/autoload.php";
use BoldSign\Configuration;
use BoldSign\Api\CustomFieldApi;
$config = new Configuration();
$config->setApiKey('YOUR_API_KEY');
$custom_field_api = new CustomFieldApi($config);
$custom_field_collection = $custom_field_api->customFieldsList($brand_id = 'YOUR_BRAND_ID');
ApiClient client = Configuration.getDefaultApiClient();
client.setApiKey("YOUR_API_KEY");
CustomFieldApi customFieldApi = new CustomFieldApi(client);
CustomFieldCollection customFieldCollection = customFieldApi.customFieldsList("YOUR_BRAND_ID");
import { CustomFieldApi } from "boldsign";
const customFieldApi = new CustomFieldApi();
customFieldApi.setApiKey("YOUR_API_KEY");
const customFieldCollection = customFieldApi.customFieldsList("YOUR_BRAND_ID");
Example response
200 Success
{
"result": [
{
"customFieldId": "string",
"fieldName": "string",
"fieldDescription": "string",
"fieldOrder": 0,
"brandId": "string",
"sharedField": true,
"formField": {
"fieldType": "Signature",
"width": 0,
"height": 0,
"isRequired": true,
"isReadOnly": true,
"value": "string",
"fontSize": 13,
"font": "Helvetica",
"fontHexColor": "string",
"isBoldFont": true,
"isItalicFont": true,
"isUnderLineFont": true,
"lineHeight": 15,
"characterLimit": 0,
"placeHolder": "string",
"validationType": "None",
"validationCustomRegex": "string",
"validationCustomRegexMessage": "string",
"dateFormat": "string",
"timeFormat": "string",
"imageInfo": {
"title": "string",
"description": "string",
"allowedFileExtensions": "string"
},
"attachmentInfo": {
"title": "string",
"description": "string",
"acceptedFileTypes": [
"string"
]
},
"editableDateFieldSettings": {
"dateFormat": "string",
"minDate": "2023-06-26T06:17:19.385Z",
"maxDate": "2023-06-26T06:17:19.385Z"
},
"hyperlinkText": "string",
"dataSyncTag": "string",
"dropdownOptions": [
"string"
],
"textAlign": "Left",
"textDirection": "LTR",
"characterSpacing": 0,
"idPrefix": "string",
"restrictIdPrefixChange": false,
"backgroundHexColor": "string"
}
}
]
}