List custom fields

get/v1/customField/list

This 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 client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.boldsign.com/v1/customField/list?brandId={brandId}");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "{{apiKey}}");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
       
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_fields_list_response = custom_field_api.custom_fields_list(brand_id="YOUR_BRAND_ID")
<?php require_once "vendor/autoload.php";

$config = new BoldSign\Configuration();
$config->setApiKey('YOUR_API_KEY');

$custom_field_api = new BoldSign\Api\CustomFieldApi($config);
$custom_fields_list_response = $custom_field_api->customFieldsList($brand_id = 'YOUR_BRAND_ID');
ApiClient client = Configuration.getDefaultApiClient();  
client.setApiKey("YOUR_API_KEY");

CustomFieldApi customFieldApi = new CustomFieldApi();
CustomFieldCollection customFieldsListResponse = customFieldApi.customFieldsList("YOUR_BRAND_ID");
import { CustomFieldApi } from "@boldsign/node-sdk";

const customFieldApi = new CustomFieldApi();
customFieldApi.setApiKey("YOUR_API_KEY");

const customFieldListResponse = 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"
      }
    }
  ]
}