---
title: "Retrieve branding"
description: "The look marketing emails' footer and the hosted unsubscribe page share, as Settings → Brand shows it: colors, the font, the company name and postal address, the page's copy and behavior, the footer's labels, the logo, and whether the \"Sent with Unitpost\" mark shows. `GET /api/v1/branding`"
url: https://www.unitpost.com/docs/platform/get-branding
section: "Platform API reference"
updated: 2026-10-13
---
# Retrieve branding

`GET /api/v1/branding`

The look marketing emails' footer and the hosted unsubscribe page share, as Settings → Brand shows it: colors, the font, the company name and postal address, the page's copy and behavior, the footer's labels, the logo, and whether the "Sent with Unitpost" mark shows. `null` means the default; `company_name` falls back to the workspace's name, so send it only to pin a different one. Requires the `templates:read` capability.

## Response fields (200)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `object` | string | yes | — |
| `company_name` | string \| null | yes | The name the footer shows; the workspace's name unless one was set. |
| `company_address` | string \| null | yes | — |
| `logo_url` | string \| null | yes | The logo emails and the unsubscribe page show: the brand logo, else the workspace image, else none. |
| `has_brand_logo` | boolean | yes | — |
| `colors` | object | yes | — |
| `font` | string \| null | yes | — |
| `hide_unitpost_branding` | boolean | yes | The stored choice. |
| `unitpost_branding_hidden` | boolean | yes | Whether recipients see no mark now: the choice, the plan and the account together. |
| `can_hide_unitpost_branding` | boolean | yes | Whether the plan allows hiding the mark. |
| `unsubscribe_page` | object | yes | — |
| `footer` | object | yes | — |

## Responses

| Status | Description |
| --- | --- |
| 200 | The branding. |
| 401 | Missing or invalid API key. |
| 403 | Insufficient scope. |
| 422 | A query key (this operation takes none). |

## Example request

```bash
curl -X GET 'https://www.unitpost.com/api/v1/branding' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'
```

## Example response (200)

```json
{
  "object": "branding",
  "company_name": "string",
  "company_address": "string",
  "logo_url": "https://example.com",
  "has_brand_logo": false,
  "colors": {
    "background": "string",
    "footer_background": "string",
    "text": "string",
    "accent": "string",
    "button_text": "string"
  },
  "font": "string",
  "hide_unitpost_branding": false,
  "unitpost_branding_hidden": false,
  "can_hide_unitpost_branding": false,
  "unsubscribe_page": {
    "title": "string",
    "description": "string",
    "confirm": false,
    "collect_reason": false,
    "show_address": false,
    "show_topics": false,
    "save_label": "string",
    "global_label": "string",
    "global_note": "string",
    "topics_heading": "string"
  },
  "footer": {
    "intro_text": "string",
    "unsubscribe_label": "string"
  }
}
```

## Links

- HTML reference (with Node.js, Python, Ruby, PHP, Laravel, Go, Java, Rust, .NET and CLI examples): https://www.unitpost.com/docs/platform/get-branding
- OpenAPI 3.1 (full schemas): https://www.unitpost.com/api/v1/openapi.json