clickup_get_doc_page_listing
Read-onlyIdempotent
List a ClickUp Doc's page hierarchy to retrieve page IDs and titles without fetching content. Quickly navigate document structure.
Instructions
List a Doc's page tree (titles and ids only, nested — no content).
A lightweight outline of the Doc: the hierarchy of pages and subpages with their ids, without fetching any body text.
When to Use:
To see a Doc's structure and grab a specific page id cheaply.
When NOT to Use:
To read page content — use
clickup_get_doc_pagesorclickup_get_page.
Returns: An indented tree of page names and ids.
Examples:
params = {"doc_id": "8cbq...", "max_page_depth": 2}
Error Handling:
404 → Doc not found. Errors return an Error ... string.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| params | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |