---
title: "Get page of portal themes"
method: GET
path: "/ui/themes"
tags: ["Management UI"]
---

# Get page of portal themes

`GET /ui/themes`

## Request

- Base URL: `/management/v2/environments/DEFAULT` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/management/v2/environments/DEFAULT/ui/themes`
- Auth: none declared

Get a page of the portal themes used in the given environment.

These themes can be used with either Portal or Portal-Next.
User must have the ENVIRONMENT_THEME[READ] permission.

## Query parameters

- `page` integer
- `perPage` integer
- `type` 'PORTAL' | 'PORTAL_NEXT': Available theme types
- `enabled` boolean

## Response `200`

Page of themes

- object
  - `data` Theme[]: List of themes.
    - union
      - ThemePortal: Theme used on the Portal
        - `id` string: Theme ID
        - `name` string: Theme ID
        - `type` 'PORTAL' | 'PORTAL_NEXT': Available theme types
        - `createdAt` string, date-time: The date (as timestamp) when the Theme was created.
        - `updatedAt` string, date-time: The last date (as timestamp) when the Theme was updated.
        - `enabled` boolean: If the theme is active
        - `logo` string: Theme logo
        - `optionalLogo` string: Optional Theme logo
        - `favicon` string: Theme favicon
        - `definition` PortalDefinition
          - `data` PortalComponentDefinition[]: List of component definitions
            - `name` string: Name of the component
            - `css` PortalCssDefinition[]: List of CSS variables
              - …
        - `backgroundImage` string: Background image used in header
      - ThemePortalNext: Theme used in Portal-Next
        - `id` string: Theme ID
        - `name` string: Theme ID
        - `type` 'PORTAL' | 'PORTAL_NEXT': Available theme types
        - `createdAt` string, date-time: The date (as timestamp) when the Theme was created.
        - `updatedAt` string, date-time: The last date (as timestamp) when the Theme was updated.
        - `enabled` boolean: If the theme is active
        - `logo` string: Theme logo
        - `optionalLogo` string: Optional Theme logo
        - `favicon` string: Theme favicon
        - `definition` PortalNextDefinition: Theme definition used for Portal-Next
          - `color` PortalNextDefinitionColor: Theme definition used for Portal-Next
            - `primary` string: Primary hex code color seed for Theme palette
            - `secondary` string: Secondary hex code color seed for Theme palette
            - `tertiary` string: Tertiary hex code color seed for Theme palette
            - `error` string: Error hex code color seed for Theme palette
            - `pageBackground` string: Background hex code color
            - `cardBackground` string: Background hex code color
          - `font` PortalNextDefinitionFont: Theme definition used for Portal-Next
            - `fontFamily` string: Font-family used for Portal-Next
          - `customCss` string: Custom CSS for Portal-Next
  - `pagination` Pagination: Generic object to handle pagination data.
    - `page` integer: The current page.
    - `perPage` integer: The number of items requested per page.
    - `pageCount` integer: The total number of pages.
    - `pageItemsCount` integer: The number of items for the current page.
    - `totalCount` integer: The total number of items, or `-1` if the count could not be computed within the configured timeout.
  - `links` Links: List of links for pagination
    - `self` string: Link to current resource
    - `first` string: In a paginated response, link to the first page
    - `last` string: In a paginated response, link to the last page
    - `previous` string: In a paginated response, link to the previous page. Maybe null if current is the first page
    - `next` string: In a paginated response, link to the next page. Maybe null if current is the last page

## Other responses

- `default`: Generic error response

## Changes

- **2024-08-26** `cb02bfb0884d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/gravitee-io/apis/gravitee-io-apim-management-api-ui/changes/ui/themes/get.md)

---

[API](https://skmtc.dev/gravitee-io/apis/gravitee-io-apim-management-api-ui.md) - [All operations](https://skmtc.dev/gravitee-io/apis/gravitee-io-apim-management-api-ui/llms.txt) - [OpenAPI document](https://skmtc.dev/gravitee-io/apis/gravitee-io-apim-management-api-ui/revisions/6e3899b14406?raw)