list_publications
readSince v1.0List the model's publications — the assembled sites and PDF reports built from navigation trees, per-type renderings and a homepage. Publications are kept separately from nodes, so search_nodes won't find them; this is how you get a publication's id before updating, rendering, publishing or deleting it. Each result gives id, name, slug, description, which trees form the site map, which rendering presents each type, any connected report services, whether readers see auto-IDs, folder, tags, and whether it has been published.
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
folder_id | String | — | Only publications in this folder. | |
name_contains | String | — | Only publications whose name contains this text. Capitalisation is ignored. | |
locale | String | — | Return names and descriptions in this language (for example 'de'). |
Example Request
{"name_contains": "Handbook"}Example Response
{"total_count": 1, "publications": [{"id": "pb-1", "name": "Service Handbook", "slug": "service-handbook", "show_auto_ids": true, "is_published": true, "homepage_length": 420}]}This content was written collaboratively with AI.