presentation-list-renderings
List renderings on a Sitecore item to see a page's composition and component placement, including index, placeholder, name, ID, datasource, and unique ID.
Instructions
Lists the renderings placed on an item — the components that make up the page. This is the tool to use to see a page's composition; presentation-get-layout returns the assigned layout definition item instead. Returns one row per rendering: Index (position in the device's rendering list, which is what presentation-add-rendering and presentation-set-rendering address), Placeholder (the full placeholder path), RenderingName, RenderingID, Datasource and UniqueId. Set includeParameters to add each rendering's Parameters.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | The ID of the item whose renderings to list (e.g. {110D559F-DEA5-42EA-9C1C-8A5DF7E70EF9}). Supply this or path. | |
| path | No | The path of the item whose renderings to list (e.g. master:/sitecore/content/Home). Supply this or id. | |
| database | No | The database containing the item. Defaults to master, and is only used with id — a path carries its own prefix. | |
| language | No | The item language. Defaults to the context language. | |
| finalLayout | No | Which layout to read. Defaults to true (the final layout), which is the effective presentation for the page. Set false to read the shared layout only. | |
| placeholder | No | Only list renderings in this placeholder. Supports wildcards, e.g. '*main*'. | |
| includeParameters | No | Include each rendering's raw Parameters string. Off by default: on an SXA or Stride site the URL-encoded parameter blobs are the largest part of the response by far (they more than doubled a 25-rendering page), and they are rarely what the caller is after. Use presentation-get-rendering-parameter to read a single one. |