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

# Get page of portal menu links

`GET /ui/portal-menu-links`

## 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/portal-menu-links`
- Auth: none declared

Get a page of the portal menu links used in the given environment.

These menu links can be used with Portal-Next to customization the links in the top bar.
User must have the ENVIRONMENT_SETTINGS[READ] permission.

## Query parameters

- `page` integer
- `perPage` integer

## Response `200`

Page of portal menu links

- object
  - `data` PortalMenuLink[]: List of portal menu links.
    - `id` string, required: Portal menu link id
    - `name` string, required: Displayed name of the menu link
    - `type` 'EXTERNAL', required: type of the menu link
    - `target` string: target of the menu link
    - `visibility` 'PUBLIC' | 'PRIVATE': visibility of the menu link
    - `order` integer, required: The order of the menu link.
  - `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-30** `3375d6eeea70`: 1 info
  - added the optional property `data/items/visibility` to the response with the `200` status
- **2024-08-26** `0bfd3b0b2723`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/gravitee-io/apis/gravitee-io-apim-management-api-ui/changes/ui/portal-menu-links/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)