Get branding with its value limits

GET

branding

settings

curl --request GET "$MITHUNAI_URL/arukz/api/v1/branding/settings" \
  --header "Authorization: Bearer $MITHUNAI_API_KEY"

import os, requests

response = requests.get(
    f"{os.environ['MITHUNAI_URL']}/arukz/api/v1/branding/settings",
    headers={"Authorization": f"Bearer {os.environ['MITHUNAI_API_KEY']}"},
    timeout=60,
)
response.raise_for_status()
print(response.json())

const response = await fetch(`${process.env.MITHUNAI_URL}/arukz/api/v1/branding/settings`, {
  headers: { Authorization: `Bearer ${process.env.MITHUNAI_API_KEY}` },
})
console.log(await response.json())

{
  "layer": {
    "identity": {
      "productName": "Northwind Answers",
      "companyName": "Northwind Traders"
    },
    "assets": {
      "logoLight": "https://cdn.northwind.example/brand/logo-light.svg"
    },
    "theme": {
      "colors": {
        "light": {
          "brand": "#1F6FEB",
          "brandHover": "#1A5FCC"
        }
      },
      "modeDefault": "system"
    },
    "domains": {
      "supportUrl": "https://support.northwind.example"
    },
    "surfaces": {
      "widget": {
        "showBranding": false
      }
    }
  },
  "revision": 3,
  "configured": true,
  "updatedAt": "2026-09-19T16:22:05.871904+00:00",
  "updatedBy": "8d3f6a21-4c9e-4b07-a1d5-e62f0b9c7a48",
  "limits": {
    "maxTextChars": 120,
    "maxUrlChars": 1024,
    "maxAssetUriChars": 262144,
    "themeModes": ["dark", "light", "system"]
  },
  "canEdit": true
}

Use this to build a branding settings form. It returns everything GET /branding returns, plus the value limits the server enforces and whether the caller may save changes. canEdit is a display hint so you can show a read-only form. It does not grant anything: PUT /branding and DELETE /branding check permission on every request. Every organization role can call this endpoint; canEdit is true for owners and admins.

Response

object

required

Your organization’s overrides. Sparse: only fields you have set appear, and an organization with no overrides returns {}. Anything absent falls back to the platform default.

Show properties

object

Names shown in the interface.

Show properties

string

Product name.

string

Short product name.

string

Company name.

string

Company legal name.

string

Tagline.

object

Logos and images.

Show properties

string

Logo for the light appearance.

string

Logo for the dark appearance.

string

Compact logo mark.

string

Browser tab icon.

string

Social sharing image.

object

Colours, typography, corner radii and default appearance.

Show properties

object

Colour palettes, one per appearance.

Show properties

object

Colour overrides for the light appearance. Each key takes a colour. Keys: background, surface, surfaceRaised, surfaceSunken, border, borderStrong, textPrimary, textSecondary, textMuted, textInverted, brand, brandHover, brandContrast, brandSubtle, accent, accentContrast, focus, success, successSubtle, warning, warningSubtle, danger, dangerSubtle, info, infoSubtle, overlay.

object

Colour overrides for the dark appearance. Each key takes a colour. Keys: background, surface, surfaceRaised, surfaceSunken, border, borderStrong, textPrimary, textSecondary, textMuted, textInverted, brand, brandHover, brandContrast, brandSubtle, accent, accentContrast, focus, success, successSubtle, warning, warningSubtle, danger, dangerSubtle, info, infoSubtle, overlay.

object

Fonts.

Show properties

string

CSS font stack for body text.

string

CSS font stack for code.

integer

Base font size in pixels.

object

Corner radii.

Show properties

string

Small radius.

string

Medium radius.

string

Large radius.

string

Extra-large radius.

string

Appearance the interface starts in.

object

Your own help links.

Show properties

string

Documentation link.

string

Support link.

object

Your own legal links and notice. Third-party attribution notices are not part of the layer and cannot be set, changed or removed through this API.

Show properties

string

Your copyright line.

object

Display toggles.

Show properties

object

Console toggles.

Show properties

boolean

Show the logo in the console.

boolean

Show the powered-by line in the console.

Website widget toggles.

Show properties

boolean

Show branding in the widget.

integer

required

Concurrency revision. 0 until the first save; each save or reset adds one. Send it back on PUT /branding or DELETE /branding.

boolean

required

true once branding has been saved or reset at least once. false means the organization has always used the platform default.

string | null

required

When branding was last saved or reset, ISO 8601 in UTC. null if never.

string | null

required

Identifier of the user or API key that last saved or reset branding. null if never.

object

required

Value limits enforced on save. They describe the API contract, not your deployment.

Show properties

integer

required

Maximum length of a text value. Currently 120.

integer

required

Maximum length of a link, or of an asset given as a URL. Currently 1024.

integer

required

Maximum length of an asset value, including inline data: images. Currently 262144.

string[]

required

Allowed theme.modeDefault values, sorted: dark, light, system.

boolean

required

Whether the caller holds the permission to change branding.

curl --request GET "$MITHUNAI_URL/arukz/api/v1/branding/settings" \
  --header "Authorization: Bearer $MITHUNAI_API_KEY"

import os, requests

response = requests.get(
    f"{os.environ['MITHUNAI_URL']}/arukz/api/v1/branding/settings",
    headers={"Authorization": f"Bearer {os.environ['MITHUNAI_API_KEY']}"},
    timeout=60,
)
response.raise_for_status()
print(response.json())

const response = await fetch(`${process.env.MITHUNAI_URL}/arukz/api/v1/branding/settings`, {
  headers: { Authorization: `Bearer ${process.env.MITHUNAI_API_KEY}` },
})
console.log(await response.json())

{
  "layer": {
    "identity": {
      "productName": "Northwind Answers",
      "companyName": "Northwind Traders"
    },
    "assets": {
      "logoLight": "https://cdn.northwind.example/brand/logo-light.svg"
    },
    "theme": {
      "colors": {
        "light": {
          "brand": "#1F6FEB",
          "brandHover": "#1A5FCC"
        }
      },
      "modeDefault": "system"
    },
    "domains": {
      "supportUrl": "https://support.northwind.example"
    },
    "surfaces": {
      "widget": {
        "showBranding": false
      }
    }
  },
  "revision": 3,
  "configured": true,
  "updatedAt": "2026-09-19T16:22:05.871904+00:00",
  "updatedBy": "8d3f6a21-4c9e-4b07-a1d5-e62f0b9c7a48",
  "limits": {
    "maxTextChars": 120,
    "maxUrlChars": 1024,
    "maxAssetUriChars": 262144,
    "themeModes": ["dark", "light", "system"]
  },
  "canEdit": true
}

Last modified on September 26, 2026

⌘I

curl --request GET "$MITHUNAI_URL/arukz/api/v1/branding/settings" \
  --header "Authorization: Bearer $MITHUNAI_API_KEY"

import os, requests

response = requests.get(
    f"{os.environ['MITHUNAI_URL']}/arukz/api/v1/branding/settings",
    headers={"Authorization": f"Bearer {os.environ['MITHUNAI_API_KEY']}"},
    timeout=60,
)
response.raise_for_status()
print(response.json())

const response = await fetch(`${process.env.MITHUNAI_URL}/arukz/api/v1/branding/settings`, {
  headers: { Authorization: `Bearer ${process.env.MITHUNAI_API_KEY}` },
})
console.log(await response.json())

{
  "layer": {
    "identity": {
      "productName": "Northwind Answers",
      "companyName": "Northwind Traders"
    },
    "assets": {
      "logoLight": "https://cdn.northwind.example/brand/logo-light.svg"
    },
    "theme": {
      "colors": {
        "light": {
          "brand": "#1F6FEB",
          "brandHover": "#1A5FCC"
        }
      },
      "modeDefault": "system"
    },
    "domains": {
      "supportUrl": "https://support.northwind.example"
    },
    "surfaces": {
      "widget": {
        "showBranding": false
      }
    }
  },
  "revision": 3,
  "configured": true,
  "updatedAt": "2026-09-19T16:22:05.871904+00:00",
  "updatedBy": "8d3f6a21-4c9e-4b07-a1d5-e62f0b9c7a48",
  "limits": {
    "maxTextChars": 120,
    "maxUrlChars": 1024,
    "maxAssetUriChars": 262144,
    "themeModes": ["dark", "light", "system"]
  },
  "canEdit": true
}

Get started

Conversations

Assistants

Models

Knowledge

Widget deployments

Widget (public)

MCP

API keys

Members

Analytics

Support access

Branding

Operations

Get branding with its value limits

Response

​Response

Response