# Get brand settings

URL: /en/docs/api/v1/brand/get
Last Updated: 2026-07-30T21:15:44.920Z

## Description
No description available.

## Available Actions
- Execute GET request
- View request parameters
- View response schema
- Get code examples
- Navigate to related topics
- View step-by-step instructions
- Get best practices

## Content
### GET /api/v1/brand

**Get brand settings**

Retrieve current brand settings for the tenant including theme colors, fonts, logo, and deployment configuration. Use `locale` or `x-locale` to retrieve content for an enabled language.

**Authentication:** Bearer token (`Authorization: Bearer <token>`)

**Query parameters:**

| Name | Type | Required | Description |
|---|---|---|---|
| `locale` | enum: en \| de \| fr \| ja \| ko \| zh | No | Enabled Trust Center content locale. |

**Header parameters:**

| Name | Type | Required | Description |
|---|---|---|---|
| `x-locale` | enum: en \| de \| fr \| ja \| ko \| zh | No | Enabled Trust Center content locale. The `locale` query parameter takes precedence. |

**Responses:**

- `200` - Brand settings retrieved successfully
  - `title` (string): Trust center title
  - `logo` (string): URL to logo image
  - `hero` (string): URL to the hero banner image
  - `primary_color` (string): Primary brand color in hex format
  - `background_color` (string): Background color in hex format
  - `text_color` (string): Text color in hex format
  - `font_family` (string): Font family for the trust center
  - `brand_extended` (object): JSON field for advanced styling; responses return sanitized `css` (max 50,000 characters).
    - `css` (string)
  - `custom_font_url` (string): URL to the uploaded custom font file
  - `custom_font_name` (string): Original filename of the uploaded custom font
  - `overview_text` (string): Overview text displayed on the trust center
  - `overview_text_2` (string): Optional second column of overview content displayed alongside the primary overview
  - `footer_text` (string): Footer text
  - `email_from` (string): Read-only transactional email sender address.
  - `emailProvider` (enum: resend | lettermint): Active transactional email provider.
  - `email_footer` (string): Optional transactional email legal footer. For a non-default locale, returns the translated footer when present and non-blank, otherwise falls back to the default-locale tenant footer. Supports multiline text, bold, italic, and http/https/mailto Markdown links.
  - `footer_links` (array of FooterLink (object)): Footer navigation links
    - `id` (string, required): Unique identifier for the link
    - `text` (string, required): Display text for the link
    - `url` (string (uri), required): URL the link points to
  - `faqs` (array of Faq (object)): Questions and answers shown in the public FAQ tab.
    - `question` (string, required)
    - `answer` (string, required)
  - `deployment_domains` (string): Comma-separated list of deployment domains

  Example (Successful response):
  
  ```json
  {
  "title": "Acme Trust Center",
  "logo": "https://directus.example.com/assets/logo-123",
  "hero": "https://directus.example.com/assets/hero-456",
  "custom_font_url": "https://directus.example.com/assets/font-789",
  "custom_font_name": "BrandFont.woff2",
  "primary_color": "#007bff",
  "background_color": "#f8f9fa",
  "text_color": "#1f2937",
  "font_family": "Inter, sans-serif",
  "overview_text": "Welcome to our trust center",
  "overview_text_2": "We also invest heavily in privacy and reliability.",
  "brand_extended": {
    "css": ".markdown-viewer h2 { color: #123456; }"
  },
  "footer_text": "© 2025 Acme. All rights reserved.",
  "email_from": "security@acme.example",
  "emailProvider": "lettermint",
  "email_footer": "Acme GmbH | Example Street 1, 20459 Hamburg | [acme.example](https://acme.example)\n\n**Managing Director:** Jane Doe | VAT ID: DE123456789\n",
  "footer_links": [
    {
      "id": "link1",
      "text": "Privacy Policy",
      "url": "https://Acme.de/privacy"
    }
  ],
  "faqs": [
    {
      "question": "How can I request access to documents?",
      "answer": "Sign in and submit an access request."
    }
  ],
  "deployment_domains": "trust.Acme.de"
}
  ```
- `401` - Unauthorized
- `403` - Forbidden - Admin role required
- `500` - Internal server error - Failed to fetch brand settings

**Code samples:**

cURL:

```bash
curl -X GET "https://app.orbiqhq.com/api/v1/brand" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json"
```