List all brands

get/v1/brand/list

This API is used to fetch the list of available brands in your organization (account). The list contains all the information of brands such as brandId, brandName, brandLogo, etc.

Code snippet

curl -X GET 'https://api.boldsign.com/v1/brand/list' \
      -H 'X-API-KEY: {your API key}'
var apiClient = new ApiClient("https://api.boldsign.com", "{your API here}");
var brandingClient = new BrandingClient(apiClient);
BrandingRecords brandingRecords = await brandingClient.ListBrandAsync().ConfigureAwait(false);
var listBrand = brandingRecords.Result;           
import requests

url = "https://api.boldsign.com/v1/brand/list"

payload={}
headers = {
  'X-API-KEY': '{use your API-KEY here}'
}

response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
const axios = require('axios'); 
const response = await axios.get('https://api.boldsign.com/v1/brand/list', { 
    headers: { 
        'X-API-KEY': '{use your API-KEY here}' 
    } 
}); 

Example response

200 Success

{
  "result": [
    {
      "brandId": "41b7483d-95de-4bd2-8c29-d56ba84c8e69",
      "brandLogo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABKYAAAfQCAIAAAB378DwAAAMNmlDQ1BEaXNwbGF5AABIiaVXd1hT2RI/
      ......
      ......
      +CYpgliBiX0ifrh7dbvEGCfbIXacAAAAASUVORK5CYII=",
      "brandName": "Syncfusion",
      "backgroundColor": "Red",
      "buttonColor": "Green",
      "buttonTextColor": "White",
      "emailDisplayName": "{SenderName} from Syncfusion",
      "disclaimerTitle": "",
      "disclaimerDescription": "",
      "redirectUrl": "http://syncfusion.com/",
      "isDefault": true,
      "canHideTagLine": false,
      "combineAuditTrail": true,
      "emailSignedDocument": "Attachment",
      "documentTimeZone": "+05:30"
    }
  ]
}