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 requests

url = "https://api.boldsign.com/v1/customField/list?brandId={brandId}"

payload = {}
headers = {
  'Accept': 'application/json',
  'Authorization': '{{apiKey}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)
const axios = require('axios');

let config = {
  method: 'get',
  maxBodyLength: Infinity,
  url: 'https://api.boldsign.com/v1/customField/list?brandId={brandId}',
  headers: { 
    'Accept': 'application/json', 
    'Authorization': '{{apiKey}}'
  }
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});
 

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
      }
    }
  ]
}