Sign in

v50

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-07-068428533.0 MB
Portal Appearance

Get Appearance Configuration

Returns the current portal appearance configuration including any custom theme, colors, fonts, and image settings. Portals using the fully-customizable portal client may override or ignore these settings by disregarding them in the code.

get/v2/portals/{portalId}/appearance

Path parameters

portalIdstring uuid required
Example:f32d905a-ed33-46a3-a093-d8f536af9a8a

The Portal identifier

Response

Details about a portal's current appearance settings.

theme_name'mint_rocket' | 'dark_mode' | 'custom' required

Select a pre-existing default theme or specify 'custom' to use custom_theme variables.

use_custom_fontsboolean required

If true, fonts in custom_fonts will be used over the theme's default fonts

Example response

{
  "theme_name": "custom",
  "use_custom_fonts": true,
  "custom_theme": {
    "colors": {
      "section": {
        "header": {
          "value": "#F8F8F8",
          "description": "Background for header"
        },
        "body": {
          "value": "#FFFFFF",
          "description": "Background for main content"
        },
        "hero": {
          "value": "#F8F8F8",
          "description": "Background for hero section"
        },
        "accent": {
          "value": "#F8F8F8",
          "description": "Subtle background"
        },
        "tertiary": {
          "value": "#FFFFFF",
          "description": "Tertiary background"
        },
        "stroke": {
          "value": "rgba(0,0,0,0.1)",
          "description": "Border color"
        },
        "footer": {
          "value": "#07A88D",
          "description": "Background for footer"
        }
      },
      "text": {
        "header": {
          "value": "rgba(0,0,0,0.8)",
          "description": "Header text"
        },
        "hero": {
          "value": "#FFFFFF",
          "description": "Hero text"
        },
        "headings": {
          "value": "rgba(0,0,0,0.8)",
          "description": "Headings text"
        },
        "primary": {
          "value": "rgba(0,0,0,0.8)",
          "description": "Main content text"
        },
        "secondary": {
          "value": "rgba(0,0,0,0.8)",
          "description": "Supporting text"
        },
        "accent": {
          "value": "#07A88D",
          "description": "Subtle text"
        },
        "link": {
          "value": "#07A88D",
          "description": "Link text"
        },
        "footer": {
          "value": "#FFFFFF",
          "description": "Footer text"
        }
      },
      "button": {
        "primary_fill": {
          "value": "#1155CB",
          "description": "Background for Primary Button"
        },
        "primary_text": {
          "value": "#FFFFFF",
          "description": "Text for Primary Button"
        }
      }
    }
  },
  "custom_fonts": {
    "base": "Roboto",
    "code": "Roboto",
    "headings": "Roboto"
  },
  "text": {
    "catalog": {
      "welcome_message": "Welcome",
      "primary_header": "Come one in!"
    }
  },
  "images": {
    "favicon": {
      "data": "data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=",
      "filename": "favicon.ico"
    },
    "logo": {
      "data": "data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=",
      "filename": "logo.png"
    },
    "catalog_cover": {
      "data": "data:image/jpeg;base64,bmljZV9sb29raW5nX3BpY3R1cmU="
    }
  }
}