List all brands
get/v1/brand/listThis 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("YOUR_API_KEY");
var brandingClient = new BrandingClient(apiClient);
BrandingRecords brandingRecords = brandingClient.ListBrand();
var brandList = brandingRecords.Result;
import boldsign
configuration = boldsign.Configuration(api_key="YOUR_API_KEY")
with boldsign.ApiClient(configuration) as api_client:
branding_api = boldsign.BrandingApi(api_client)
branding_records = branding_api.brand_list()
<?php require_once "vendor/autoload.php";
use BoldSign\Configuration;
use BoldSign\Api\BrandingApi;
$config = new Configuration();
$config->setApiKey('YOUR_API_KEY');
$branding_api = new BrandingApi($config);
$branding_records = $branding_api->brandList();
ApiClient client = Configuration.getDefaultApiClient();
client.setApiKey("YOUR_API_KEY");
BrandingApi brandingApi = new BrandingApi(client);
BrandingRecords brandingRecords = brandingApi.brandList();
import { BrandingApi } from "boldsign";
const brandingApi = new BrandingApi();
brandingApi.setApiKey("YOUR_API_KEY");
const brandingRecords = brandingApi.brandList();
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",
"showBuiltInFormFields": true,
"allowCustomFieldCreation": false,
"showSharedCustomFields": false,
"hideDecline": false,
"hideSave":false,
"excludeAuditTrailFromEmail": false,
"DocumentExpirySettings": {
"expiryDateType": "Days",
"expiryValue": 60,
"enableDefaultExpiryAlert": false,
"enableAutoReminder": false,
"reminderDays": 3,
"reminderCount": 5
},
"customDomainSettings": {
"domainName": "mail.cubeflakes.com",
"fromName": "notification"
},
"isDomainVerified": false
}
]
}