---
title: "Get a portal menu link"
method: GET
path: "/ui/portal-menu-links/{portalMenuLinkId}"
tags: ["Management UI"]
---

# Get a portal menu link

`GET /ui/portal-menu-links/{portalMenuLinkId}`

## 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/{portalMenuLinkId}`
- Auth: none declared

Get a portal menu link used in the given environment.

User must have the ENVIRONMENT_SETTINGS[READ] permission.

## Query parameters

- `page` integer
- `perPage` integer

## Response `200`

The requested portal menu link

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

## Other responses

- `default`: Generic error response

## Changes

- **2024-08-30** `3375d6eeea70`: 1 info
  - added the optional property `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/:portalMenuLinkId/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)