---
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`

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

---

[API](https://skmtc.net/gravitee-io/apis/gravitee-io-apim-management-api-ui.md) · [All operations](https://skmtc.net/gravitee-io/apis/gravitee-io-apim-management-api-ui/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gravitee-io/gravitee-io-apim-management-api-ui/revisions/6e3899b14406/schema)