Portlets

Read one custom content tool's configuration

Changed on

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.

get/api/v1/portlet/custom/{portletId}

Request

Path parameters

portletIdstring required

Stored id of the custom tool, c_ prefix included

Response

Custom tool found

i18nMessagesMapobject
permissionsstring[]

Example response

{
  "entity": {
    "portletId": "c_press-releases",
    "portletName": "Press Releases",
    "dataViewMode": "card"
  }
}

Changes