---
title: "Get Appearance Configuration"
url: "https://nov18-dev.movespot.fyi/apis/portal-management-2/versions/5611abf1-a964-48d3-9512-55f58a30ef37/operations/get-portal-appearance"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/portal-management-2/versions/5611abf1-a964-48d3-9512-55f58a30ef37.md

# Get Appearance Configuration

`GET` `/portals/{portalId}/appearance`

Operation ID: `get-portal-appearance`

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.

## Path parameters

- `portalId` (string, uuid, required) - ID of the portal.

## Responses

- `200` - Details about a portal's current appearance settings.
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Portal Management
  version: 2.2.2
servers:
  - url: https://us.api.konghq.com/v2
    description: United-States Production region
  - url: https://eu.api.konghq.com/v2
    description: Europe Production region
  - url: https://au.api.konghq.com/v2
    description: Australia Production region
  - url: https://me.api.konghq.com/v2
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v2
    description: India Production region
  - url: https://sg.api.konghq.com/v2
    description: Singapore Production region
paths:
  /portals/{portalId}/appearance:
    get:
      operationId: get-portal-appearance
      summary: Get Appearance Configuration
      description: 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.
      parameters:
        - $ref: "#/components/parameters/PortalId"
      responses:
        "200":
          $ref: "#/components/responses/GetPortalAppearance"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Portal Appearance
security:
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    PortalId:
      schema:
        type: string
        format: uuid
      name: portalId
      in: path
      required: true
      description: ID of the portal.
  responses:
    GetPortalAppearance:
      description: Details about a portal's current appearance settings.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/GetPortalAppearanceResponse"
          examples:
            Example 1:
              $ref: "#/components/examples/GetPortalAppearanceExample1"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  schemas:
    GetPortalAppearanceResponse:
      example:
        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 on 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=
      allOf:
        - $ref: "#/components/schemas/PortalAppearance"
        - type: object
          required:
            - theme_name
            - use_custom_fonts
            - custom_theme
            - custom_fonts
            - text
            - images
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    PortalAppearance:
      type: object
      properties:
        theme_name:
          $ref: "#/components/schemas/PortalTheme"
        custom_theme:
          $ref: "#/components/schemas/NullableAppearanceThemeVariables"
        custom_fonts:
          $ref: "#/components/schemas/NullableAppearanceFonts"
        use_custom_fonts:
          description: If true, fonts in custom_fonts will be used over the theme's
            default fonts
          type: boolean
          nullable: false
        text:
          $ref: "#/components/schemas/NullableAppearanceTextVariables"
        images:
          $ref: "#/components/schemas/AppearanceImages"
      example:
        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=
      additionalProperties: false
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    PortalTheme:
      description: Select a pre-existing default theme or specify 'custom' to use
        custom_theme variables.
      type: string
      example: mint_rocket
      enum:
        - mint_rocket
        - dark_mode
        - custom
    NullableAppearanceThemeVariables:
      description: Groups of variables for configuring visual details of the portal
        user interface. Set theme_name to 'custom' to use custom values for
        theme variables.
      type: object
      properties:
        colors:
          $ref: "#/components/schemas/AppearanceThemeColorVariables"
      example:
        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
      additionalProperties: false
      nullable: true
      required:
        - colors
      title: AppearanceThemeVariables
    NullableAppearanceFonts:
      description: Font selections to render text in the portal user interface. Must
        set use_custom_fonts to true to enable using custom font values.
      type: object
      properties:
        base:
          $ref: "#/components/schemas/AppearanceFontName"
        code:
          $ref: "#/components/schemas/AppearanceFontName"
        headings:
          $ref: "#/components/schemas/AppearanceFontName"
      additionalProperties: false
      nullable: true
      required:
        - base
        - code
        - headings
    NullableAppearanceTextVariables:
      description: Values to display for customizable text in the portal user interface
      type: object
      properties:
        catalog:
          type: object
          additionalProperties: false
          properties:
            welcome_message:
              type: string
              maxLength: 512
            primary_header:
              type: string
              maxLength: 512
          required:
            - welcome_message
            - primary_header
      example:
        catalog:
          welcome_message: Welcome to our service catalog
          primary_header: Find All of Our Services in a Single Place
      additionalProperties: false
      nullable: true
      required:
        - catalog
    AppearanceImages:
      description: A collection of binary image data to customize images in the portal
      type: object
      properties:
        logo:
          $ref: "#/components/schemas/AppearanceImage"
        favicon:
          $ref: "#/components/schemas/AppearanceImage"
        catalog_cover:
          $ref: "#/components/schemas/AppearanceImage"
      example:
        logo:
          data: data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=
        favicon:
          data: data:image/png;base64,bmljZV9sb29raW5nX3BpY3R1cmU=
        catalog_cover:
          data: data:image/jpeg;base64,bmljZV9sb29raW5nX3BpY3R1cmU=
      additionalProperties: false
      nullable: true
    AppearanceThemeColorVariables:
      type: object
      properties:
        section:
          type: object
          additionalProperties: false
          properties:
            header:
              $ref: "#/components/schemas/AppearanceColorVariable"
            body:
              $ref: "#/components/schemas/AppearanceColorVariable"
            hero:
              $ref: "#/components/schemas/AppearanceColorVariable"
            accent:
              $ref: "#/components/schemas/AppearanceColorVariable"
            tertiary:
              $ref: "#/components/schemas/AppearanceColorVariable"
            stroke:
              $ref: "#/components/schemas/AppearanceColorVariable"
            footer:
              $ref: "#/components/schemas/AppearanceColorVariable"
          required:
            - header
            - body
            - hero
            - accent
            - tertiary
            - stroke
            - footer
        text:
          type: object
          additionalProperties: false
          properties:
            header:
              $ref: "#/components/schemas/AppearanceColorVariable"
            hero:
              $ref: "#/components/schemas/AppearanceColorVariable"
            headings:
              $ref: "#/components/schemas/AppearanceColorVariable"
            primary:
              $ref: "#/components/schemas/AppearanceColorVariable"
            secondary:
              $ref: "#/components/schemas/AppearanceColorVariable"
            accent:
              $ref: "#/components/schemas/AppearanceColorVariable"
            link:
              $ref: "#/components/schemas/AppearanceColorVariable"
            footer:
              $ref: "#/components/schemas/AppearanceColorVariable"
          required:
            - header
            - hero
            - headings
            - primary
            - secondary
            - accent
            - link
            - footer
        button:
          type: object
          additionalProperties: false
          properties:
            primary_fill:
              $ref: "#/components/schemas/AppearanceColorVariable"
            primary_text:
              $ref: "#/components/schemas/AppearanceColorVariable"
          required:
            - primary_fill
            - primary_text
      example:
        section:
          header:
            value: "#0A161E"
            description: Background for header
          body:
            value: "#0C0C0C"
            description: Background for main content
          hero:
            value: "#1A1D21"
            description: Background for hero section
          accent:
            value: "#1F1F1F"
            description: Subtle background
          tertiary:
            value: "#222529"
            description: Tertiary background
          stroke:
            value: "#34393F"
            description: Border color
          footer:
            value: "#212429"
            description: Background for footer
        text:
          header:
            value: "#FFFFFF"
            description: Header text
          hero:
            value: rgba(255,255,255,0.8)
            description: Hero text
          headings:
            value: "#FFFFFF"
            description: Headings text
          primary:
            value: "#C8C8C9"
            description: Main content text
          secondary:
            value: "#919294"
            description: Supporting text
          accent:
            value: "#FFFFFF"
            description: Subtle text
          link:
            value: "#2977FF"
            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
      additionalProperties: false
      required:
        - section
        - text
        - button
    AppearanceFontName:
      description: The name of the font to render in the browser.
      type: string
      example: Roboto
      enum:
        - Roboto
        - Inter
        - Open Sans
        - Lato
        - Slabo 27px
        - Slabo 13px
        - Oswald
        - Source Sans Pro
        - Montserrat
        - Raleway
        - PT Sans
        - Lora
        - Roboto Mono
        - Inconsolata
        - Source Code Pro
        - PT Mono
        - Ubuntu Mono
        - IBM Plex Mono
    AppearanceImage:
      description: The image data to upload, along with an optional filename. Images
        must be a data URL with binary image data in base 64 format. See
        https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs.
      type: object
      properties:
        data:
          oneOf:
            - $ref: "#/components/schemas/ImagePNGDataUri"
            - $ref: "#/components/schemas/ImageJPGDataUri"
            - $ref: "#/components/schemas/ImageGIFDataUri"
            - $ref: "#/components/schemas/ImageICODataUri"
        filename:
          type: string
          maxLength: 512
      example:
        data: data:image/jpeg;base64,bmljZV9sb29raW5nX3BpY3R1cmU=
      additionalProperties: false
      nullable: true
      required:
        - data
    AppearanceColorVariable:
      type: object
      properties:
        value:
          type: string
          maxLength: 255
        description:
          type: string
          maxLength: 512
      example:
        value: "#000000"
        description: The color for a type of thing
      additionalProperties: false
      required:
        - value
    ImagePNGDataUri:
      description: must be a data URL with base64 PNG image data, e.g.,
        data:image/png;base64,<BASE64_IMAGE_DATA>
      type: string
      format: uri
      example: data:image/png,YW5faW1hZ2VfZmlsZQ==
      pattern: ^data:image/png(;base64)?,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
      title: ImagePNGDataUri
      x-validation-message: must be a data URL with base64 PNG image data, e.g.,
        data:image/png;base64,<BASE64_IMAGE_DATA>
    ImageJPGDataUri:
      description: must be a data URL with base64 JPEG image data, e.g.,
        data:image/jpeg;base64,<BASE64_IMAGE_DATA>
      type: string
      format: uri
      example: data:image/jpeg,YW5faW1hZ2VfZmlsZQ==
      pattern: ^data:image/jpeg(;base64)?,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
      title: ImageJPGDataUri
      x-validation-message: must be a data URL with base64 JPEG image data, e.g.,
        data:image/jpeg;base64,<BASE64_IMAGE_DATA>
    ImageGIFDataUri:
      description: must be a data URL with base64 GIF image data, e.g.,
        data:image/gif;base64,<BASE64_IMAGE_DATA>
      type: string
      format: uri
      example: data:image/gif,YW5faW1hZ2VfZmlsZQ==
      pattern: ^data:image/gif(;base64)?,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
      title: ImageGIFDataUri
      x-validation-message: must be a data URL with base64 GIF image data, e.g.,
        data:image/gif;base64,<BASE64_IMAGE_DATA>
    ImageICODataUri:
      description: must be a data URL with base64 ICO image data, e.g.,
        data:image/ico;base64,<BASE64_IMAGE_DATA>
      type: string
      format: uri
      example: data:image/ico,YW5faW1hZ2VfZmlsZQ==
      pattern: ^data:image/(x-icon|ico|icon|vnd.microsoft.icon)(;base64)?,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
      title: ImageICODataUri
      x-validation-message: must be a data URL with base64 ICO image data, e.g.,
        data:image/ico;base64,<BASE64_IMAGE_DATA>
  examples:
    GetPortalAppearanceExample1:
      value:
        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 on 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=
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  securitySchemes:
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
```
