---
title: "Get Customization"
method: GET
path: "/v3/portals/{portalId}/customization"
tags: ["Portal Customization"]
---

# Get Customization

`GET /v3/portals/{portalId}/customization`

## Request

- Base URL: `https://global.api.konghq.com`
- URL: `https://global.api.konghq.com/v3/portals/{portalId}/customization`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer
  - HTTP bearer
  - HTTP bearer

Returns the portal customization options.

## Path parameters

- `portalId` string, uuid, required

## Response `200`

The current customization options for a portal.

- PortalCustomizationV3: The custom settings of this portal
  - `theme` object: The theme settings for this portal.
    - `name` string: The theme name to apply to this portal. Supported names are 'ocean', 'mesa', and 'grove'. If another name is provided or this property is omitted, the portal uses the default 'ocean' theme.
    - `mode` 'light' | 'dark' | 'system'
    - `colors` object
      - `primary` string: The primary accent color used in the portal's theme. Must be a valid hex color value.
  - `layout` string: This property is deprecated and is not used by the portal.
  - `css` string, nullable
  - `menu` object
    - `main` PortalMenuItem[]
      - `path` string, required: The absolute path of a page in a portal with a leading slash.
      - `title` string, required: The link display text
      - `visibility` 'public' | 'private', required: Whether a menu item is public or private. Private menu items are only accessible to authenticated users.
      - `external` boolean, required: When clicked, open the link in a new window
    - `footer_sections` PortalFooterMenuSection[]
      - `title` string, required: The footer menu section title
      - `items` PortalMenuItem[], required
        - `path` string, required: The absolute path of a page in a portal with a leading slash.
        - `title` string, required: The link display text
        - `visibility` 'public' | 'private', required: Whether a menu item is public or private. Private menu items are only accessible to authenticated users.
        - `external` boolean, required: When clicked, open the link in a new window
    - `footer_bottom` PortalMenuItem[]
      - `path` string, required: The absolute path of a page in a portal with a leading slash.
      - `title` string, required: The link display text
      - `visibility` 'public' | 'private', required: Whether a menu item is public or private. Private menu items are only accessible to authenticated users.
      - `external` boolean, required: When clicked, open the link in a new window
  - `spec_renderer` object: The spec renderer settings of this portal
    - `try_it_ui` boolean: Enable in-browser testing for your APIs. All linked gateways must have the CORS plugin configured.
    - `try_it_insomnia` boolean: Enables users to open API specifications in Insomnia to explore and send requests with the native client. Only public API specifications are supported.
    - `infinite_scroll` boolean: Display the full spec on a single, scrollable page. If disabled, documentation, endpoints, and schemas appear on separate pages.
    - `show_schemas` boolean: Control whether schemas are visible in your API specs. When enabled, schemas appear in the side navigation below the endpoints.
    - `hide_internal` boolean: Manage visibility of internal endpoints and models.
    - `hide_deprecated` boolean: Manage visibility of deprecated endpoints and models.
    - `allow_custom_server_urls` boolean: Let users define a custom server URL for endpoints. This will be used to generate code snippets and to test the API. The URL is client-side only and is not saved.
    - `try_it_ui_audience` 'all' | 'authenticated' | 'registered': The audience for the Try It UI feature. `all` means that the Try It UI will be available to all users, including unauthenticated users. `authenticated` means that the Try It UI will only be available to authenticated users. `registered` means that the Try It UI will only be available to users who have registered for the API.
  - `robots` string, nullable

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found

## Changes

- **2026-10-15** `7aab863a6daa`: 1 info
  - added the optional property `spec_renderer/try_it_ui_audience` to the response with the `200` status
- **2026-10-07** `59663dd13a10`: 2 info
  - the `name` response's property default value `ocean` was added for the status `200`
  - response property `layout` deprecated
- **2026-09-25** `68d43091b84d`: 2 warning
  - added the new `403.00` enum value to the `status` response property for the response status `403`
  - added the new `404.00` enum value to the `status` response property for the response status `404`
- **2026-09-18** `f324fb7610e4`: 2 breaking, 1 warning, 17 info
  - the response's body type changed from no type to `object` for status `403`
  - the response's body type changed from no type to `object` for status `404`
  - removed the optional property `spec_renderer/try_it_ui_audience` from the response with the `200` status
  - removed `#/components/schemas/BaseError, subschema #2` from the response body `allOf` list for the response status `401`
  - …16 more
- **2026-09-07** `d2254a6fbee0`: 1 info
  - added the optional property `spec_renderer/try_it_ui_audience` to the response with the `200` status

[Operation history](https://skmtc.dev/kong/apis/konnect-api-go-sdk/changes/v3/portals/:portalId/customization/get.md)

---

[API](https://skmtc.dev/kong/apis/konnect-api-go-sdk.md) · [All operations](https://skmtc.dev/kong/apis/konnect-api-go-sdk/llms.txt) · [OpenAPI document](https://skmtc.dev/kong/apis/konnect-api-go-sdk/revisions/7aab863a6daa?raw)