diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index aa0b72d..f33e1dd 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -621,6 +621,7 @@ export default withMermaid( collapsed: true, items: [ { text: "Overview", link: "/api-reference/page/overview" }, + { text: "List Workspace Pages", link: "/api-reference/page/list-workspace-pages" }, { text: "Add Workspace Page", link: "/api-reference/page/add-workspace-page" }, { text: "Add Project Page", link: "/api-reference/page/add-project-page" }, { text: "Get Workspace Page", link: "/api-reference/page/get-workspace-page" }, diff --git a/docs/api-reference/page/list-workspace-pages.md b/docs/api-reference/page/list-workspace-pages.md new file mode 100644 index 0000000..c9585c5 --- /dev/null +++ b/docs/api-reference/page/list-workspace-pages.md @@ -0,0 +1,165 @@ +--- +title: List workspace wiki pages +description: List workspace wiki pages via Plane API. HTTP request format, parameters, scopes, and example responses for listing workspace wiki pages. +keywords: plane, plane api, rest api, api integration, page, list workspace wiki pages, wiki pages +--- + +# List workspace wiki pages + +
+ GET + /api/v1/workspaces/{workspace_slug}/pages/ +
+ +
+
+ +List all wiki pages in a workspace with optional filtering and search. + +
+ +### Path Parameters + +
+ + + +The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`. + + + +
+
+ +
+ +### Query Parameters + +
+ + + +Filter pages by scope. Defaults to `all`. + +- `all` — all pages the user has access to +- `public` — pages with public access, excluding archived +- `private` — pages owned by the user and not shared, excluding archived +- `shared` — private pages explicitly shared with the user +- `archived` — pages that have been archived + + + + + +Case-insensitive search on page title. + + + + + +Number of results per page. Defaults to `20`, maximum `100`. + + + + + +Pagination cursor for getting the next or previous set of results. + + + +
+
+ +
+ +### Scopes + +`wiki.pages:read` + +
+ +
+ +
+ + + + + + + + + +```json +{ + "grouped_by": null, + "sub_grouped_by": null, + "total_count": 4, + "next_cursor": "20:1:0", + "prev_cursor": "20:-1:1", + "next_page_results": false, + "prev_page_results": false, + "count": 4, + "total_pages": 1, + "total_results": 4, + "extra_stats": null, + "results": [ + { + "id": "b3478c56-31f6-4f7e-b445-8392a4b26621", + "name": "welcome 3 b", + "owned_by": "5b0af4aa-e310-408a-a480-868429af5701", + "access": 0, + "is_locked": false, + "archived_at": null, + "workspace": "8725ddfa-c181-49f6-9173-97b8d0b7d599", + "created_at": "2026-04-01T15:41:19.062280Z", + "updated_at": "2026-04-07T19:30:39.274060Z", + "logo_props": {}, + "parent_id": "a2819c8b-f7ac-4cbd-b971-682726c4f8cc" + } + ] +} +``` + + + +
+ +