GRgravitee-io
Portal Navigation Items

Get portal navigation items

Changed on

User must have the ENVIRONMENT_DOCUMENTATION[read] permission.

get/portal-navigation-items

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/portal-navigation-items
  • Auth
    • HTTP basic
    • or API key in cookie Auth-Graviteeio-APIM

Query parameters

area'HOMEPAGE' | 'TOP_NAVBAR'

The portal area (used by portal navigation items)

Example:TOP_NAVBAR

The portal area (eg. "homepage", "top_navbar")

parentIdstring

The parent ID to filter navigation items

loadChildrenboolean

Whether to load children items

includesstring[]

Additional data to include in the response, returned as a separate metadata map rather than inlined onto each item.

Response

A list of portal navigation items

Example response

{
  "items": [
    {
      "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
      "organizationId": "DEFAULT",
      "environmentId": "DEFAULT",
      "type": "FOLDER",
      "area": "TOP_NAVBAR",
      "parentId": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
      "rootId": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
      "order": 2,
      "published": true,
      "visibility": "PUBLIC",
      "portalPageContentId": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
      "source": {
        "type": "github-fetcher",
        "fetchCron": "0 */10 * * * *",
        "lastFetchedAt": "2026-07-17T00:00:00.000Z",
        "lastFetchAttemptAt": "2026-07-17T00:00:00.000Z"
      }
    }
  ]
}

Changes

  • 1b43518fec30Revision changes
    • info

      added the new optional query request parameter includes

    • info

      added the optional property to the response with the status

  • 37e8cbe5f769Revision changes
    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status