Get brand
get/v1/brand/getThis API is used to fetch the specific brand in your account. The brand contains information such as brandId, brandName, brandLogo, etc.
Code snippet
curl -X GET 'https://api.boldsign.com/v1/brand/get?brandId={brandid}' \ -H 'X-API-KEY: {your API key}'
var apiClient = new ApiClient("https://api.boldsign.com", "{your API here}"); var brandingClient = new BrandingClient(apiClient); BrandDetails brandDetails = await brandingClient.GetBrandDetailsAsync("5f20d408-0ca6-4a00-a121-04ddd828b1df").ConfigureAwait(false); var getBrand = brandDetails.Result;
import boldsign configuration = boldsign.Configuration(api_key="YOUR_API_KEY") with boldsign.ApiClient(configuration) as api_client: branding_api = boldsign.BrandingApi(api_client) brand_details_response = branding_api.get_brand(brand_id="YOUR_BRAND_ID")
<?php require_once "vendor/autoload.php"; $config = new BoldSign\Configuration(); $config->setApiKey('YOUR_API_KEY'); $branding_api = new BoldSign\Api\BrandingApi($config); $brand_details_response = $branding_api->getBrand($brand_id = 'YOUR_BRAND_ID');
ApiClient client = Configuration.getDefaultApiClient(); client.setApiKey("YOUR_API_KEY"); BrandingApi brandingApi = new BrandingApi(client); ViewBrandDetails brandDetails = brandingApi.getBrand("YOUR_BRAND_ID");
import { BrandingApi } from "@boldsign/node-sdk"; const brandingApi = new BrandingApi(); brandingApi.setApiKey("YOUR_API_KEY"); const brandDetailsResponse = brandingApi.getBrand("YOUR_BRAND_ID");
Example response
200 Success
{ "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 }