---
title: "List the tools that can be placed in a navigation section"
method: GET
path: "/api/v1/portlet/_catalog"
tags: ["Portlets"]
---

# List the tools that can be placed in a navigation section

`GET /api/v1/portlet/_catalog`

## Request

- Base URL: `https://docs.anzworldline-solutions.com.au`
- URL: `https://docs.anzworldline-solutions.com.au/api/v1/portlet/_catalog`
- Auth: none declared
- TypeScript: <https://skmtc.dev/anzworldline-solutions/apis/dotcms-rest-api/docs/api/v1/portlet/_catalog/get.ts> (a function with typed inputs; its response is checked against the schema)

Every portlet that can be added to a section, with the same inclusion rules as the legacy Roles & Tools tool picker: portlets excluded from layouts are omitted, and the old Languages tool is omitted while FEATURE_FLAG_LOCALES_HIDE_OLD_LANGUAGES_PORTLET is on. Sorted by title ignoring letter case. Each row carries the id, the localized title and an isCustom flag that is true only for tools an admin created through New Tool. Requires an authenticated back-end user with access to the tools or tools-beta portlet, or the CMS Administrator role.

## Response `200`

Catalog retrieved

- ResponseEntityToolCatalogView
  - `errors` ErrorEntity[]
    - `errorCode` string
    - `message` string
    - `fieldName` string
  - `entity` ToolCatalogEntryView[]
    - `id` string: Portlet id, e.g. roles or c_press-releases
    - `title` string: Title in the caller's language; falls back to the registered name, then to the id
    - `isCustom` boolean: True only for tools created through New Tool: registered in the database and not declared in the product's portlet id registry. False for every shipped tool, Language Variables included
  - `messages` MessageEntity[]
    - `message` string
  - `i18nMessagesMap` object
  - `permissions` string[]
  - `pagination` Pagination
    - `currentPage` integer
    - `perPage` integer
    - `totalEntries` integer

## Other responses

- `401`: Unauthorized - no authenticated back-end user, or the caller holds neither the tools nor the tools-beta portlet and is not a CMS Administrator

## Changes

- **2026-10-30** `4fd8e917d458`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/anzworldline-solutions/apis/dotcms-rest-api/changes/api/v1/portlet/_catalog/get.md)

---

[API](https://skmtc.dev/anzworldline-solutions/apis/dotcms-rest-api.md) - [All operations](https://skmtc.dev/anzworldline-solutions/apis/dotcms-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/anzworldline-solutions/apis/dotcms-rest-api/revisions/4fd8e917d458?raw)