Get dashboard branding
Retrieve the branding configuration for a dashboard.
GET /app/dashboards/{id}/branding
Returns the logos, header navigation links, primary accent color, subscriber email from display name, and subscriber email postal address for a dashboard's status dashboard. Requires the Custom Branding feature entitlement.
Path parameters
| Parameter | Description |
|---|---|
id | The UUID of the dashboard. |
Request
See API Basics for required headers.
This endpoint takes no request body.
Sample request
curl https://api.statusdashboard.com/app/dashboards/a1b2c3d4-e5f6-7890-abcd-ef1234567890/branding \
-H "Authorization: Bearer bcf847abf5c6:def456"Sample response
Status: 200 OK
{
"headerLogoUrl": "https://d1abc.cloudfront.net/org-id/dash-id/header-logo.png",
"headerLogoKey": "tenant-assets/org-id/dash-id/headerLogo.png",
"mainLogoUrl": "https://d1abc.cloudfront.net/org-id/dash-id/main-logo.png",
"mainLogoKey": "tenant-assets/org-id/dash-id/mainLogo.png",
"faviconUrl": "https://d1abc.cloudfront.net/org-id/dash-id/favicon.ico",
"faviconKey": "tenant-assets/org-id/dash-id/favicon.ico",
"emailLogoUrl": "https://d1abc.cloudfront.net/org-id/dash-id/emailLogo.png",
"emailLogoKey": "tenant-assets/org-id/dash-id/emailLogo.png",
"headerLinks": [
{ "label": "Home", "url": "https://acme.com" },
{ "label": "Support", "url": "https://acme.com/support" }
],
"primaryColor": "#475569",
"emailFromName": "Acme Status",
"emailPostalAddress": "456 Tenant St, Oakland, CA 94612"
}When no branding has been configured, returns an empty object {}. When emailFromName or emailPostalAddress is unset, the field is omitted from the response.
Response fields
Same fields as Update dashboard branding. On GET, logo and link fields are omitted when unset (rather than returned as empty strings). primaryColor defaults to #475569 on new dashboards when never customized.
Error responses
| Status | When |
|---|---|
403 | Insufficient permissions, or the Custom Branding feature is not enabled. |
404 | Dashboard not found or does not belong to the caller's organization. |

