---
title: "Read one custom content tool's configuration"
method: GET
path: "/api/v1/portlet/custom/{portletId}"
tags: ["Portlets"]
---

# Read one custom content tool's configuration

`GET /api/v1/portlet/custom/{portletId}`

## Request

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

Returns the editable configuration of a custom content tool: id, name, base types, content types and data view mode. Requires an authenticated back-end user with access to the tools or tools-beta portlet, or the CMS Administrator role.

## Path parameters

- `portletId` string, required

## Response `200`

Custom tool found

- ResponseEntityCustomToolView
  - `errors` ErrorEntity[]
    - `errorCode` string
    - `message` string
    - `fieldName` string
  - `entity` CustomToolView: Editable configuration of a custom content tool
    - `portletId` string: Stored id including the c_ prefix
    - `portletName` string: Display name of the tool
    - `baseTypes` string[]: Base type names as stored (CONTENT, WIDGET, PERSONA, FILEASSET, HTMLPAGE, VANITY_URL, DOTASSET, FORM, KEY_VALUE); empty when none
    - `contentTypes` string[]: Content type variable names; empty when none
    - `dataViewMode` string: list or card, as stored
  - `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
- `404`: No portlet has this id, or it is a tool shipped with the product and has no custom configuration

## Changes

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

[Operation history](https://skmtc.dev/anzworldline-solutions/apis/dotcms-rest-api/changes/api/v1/portlet/custom/:portletId/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)