list_renderings
readSince v1.0List the model's renderings — the page templates that say how elements of a given type are presented on Reader pages, published site pages and PDF chapters. Renderings are kept separately from nodes, so search_nodes won't find them; this is how you get a rendering's id before updating, previewing or deleting it. Each result gives id, name, the type it targets, description, folder, tags, and how long its document is.
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
locale | String | — | Return names and descriptions in this language (for example 'de'). | |
target_type_id | String | — | Only renderings that present this node or relationship type. | |
name_contains | String | — | Only renderings whose name contains this text. Capitalisation is ignored. | |
folder_id | String | — | Only renderings in this folder. |
Example Request
{"name_contains": "Service"}Example Response
{"total_count": 1, "renderings": [{"id": "4e2a...", "name": "Service page", "target_type_id": "nt-uuid", "description": "Full page for the website", "document_length": 842, "tags": []}]}This content was written collaboratively with AI.