List pages
list_pagesUse this tool when you need some of the workspace's pages by URL: every page under /guides/, the pages on www.example.com, or the ones not live yet (ページ一覧, ホームページ, Webサイト, ランディングページ). For a workspace with hundreds of pages it finds a page's siteId by its path.
Lists the pages of the workspace's sites on Convika, top-level paths first and then by path, as short rows: id (its siteId), name, path, status, url, and access: public, password, or private_link (only people sent the link). Link a public page only from a page anyone can read.
host: one site, such as www.example.com; without it, every site, each page once, at the site of its main URL.
pathPrefix: paths that start with it. "/guides/" lists the pages under /guides/; "/guides" also includes /guides itself.
status: draft, preview, or production (live).
limit: default 50, up to 200; a reply that would pass about 6,000 tokens holds fewer. total counts every matching page; while hasMore is true, nextCursor passed as cursor gives the next set with the same filters. A path that isn't listed has no page: create_page makes one there. Read-only.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| host | No | One of the workspace's sites, such as 'www.example.com'; leave out for all | |
| limit | No | Pages to return, default 50 | |
| cursor | No | nextCursor from the last call, for the next set | |
| status | No | Keep pages in this state only | |
| pathPrefix | No | Keep paths that start with this, such as '/guides/' |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| host | Yes | ||
| note | No | ||
| brand | Yes | ||
| pages | Yes | ||
| total | Yes | ||
| status | Yes | ||
| hasMore | Yes | ||
| nextCursor | Yes | ||
| pathPrefix | Yes |