Skip to content

Commit 648ae1c

Browse files
iam-vipinclaude
andcommitted
add list workspace wiki pages API doc
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 9fa5d12 commit 648ae1c

File tree

2 files changed

+166
-0
lines changed

2 files changed

+166
-0
lines changed

docs/.vitepress/config.mts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -621,6 +621,7 @@ export default withMermaid(
621621
collapsed: true,
622622
items: [
623623
{ text: "Overview", link: "/api-reference/page/overview" },
624+
{ text: "List Workspace Pages", link: "/api-reference/page/list-workspace-pages" },
624625
{ text: "Add Workspace Page", link: "/api-reference/page/add-workspace-page" },
625626
{ text: "Add Project Page", link: "/api-reference/page/add-project-page" },
626627
{ text: "Get Workspace Page", link: "/api-reference/page/get-workspace-page" },
Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
---
2+
title: List workspace wiki pages
3+
description: List workspace wiki pages via Plane API. HTTP request format, parameters, scopes, and example responses for listing workspace wiki pages.
4+
keywords: plane, plane api, rest api, api integration, page, list workspace wiki pages, wiki pages
5+
---
6+
7+
# List workspace wiki pages
8+
9+
<div class="api-endpoint-badge">
10+
<span class="method get">GET</span>
11+
<span class="path">/api/v1/workspaces/{workspace_slug}/pages/</span>
12+
</div>
13+
14+
<div class="api-two-column">
15+
<div class="api-left">
16+
17+
List all wiki pages in a workspace with optional filtering and search.
18+
19+
<div class="params-section">
20+
21+
### Path Parameters
22+
23+
<div class="params-list">
24+
25+
<ApiParam name="workspace_slug" type="string" :required="true">
26+
27+
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`.
28+
29+
</ApiParam>
30+
31+
</div>
32+
</div>
33+
34+
<div class="params-section">
35+
36+
### Query Parameters
37+
38+
<div class="params-list">
39+
40+
<ApiParam name="type" type="string" :required="false">
41+
42+
Filter pages by scope. Defaults to `all`.
43+
44+
- `all` — all pages the user has access to
45+
- `public` — pages with public access, excluding archived
46+
- `private` — pages owned by the user and not shared, excluding archived
47+
- `shared` — private pages explicitly shared with the user
48+
- `archived` — pages that have been archived
49+
50+
</ApiParam>
51+
52+
<ApiParam name="search" type="string" :required="false">
53+
54+
Case-insensitive search on page title.
55+
56+
</ApiParam>
57+
58+
<ApiParam name="per_page" type="integer" :required="false">
59+
60+
Number of results per page. Defaults to `20`, maximum `100`.
61+
62+
</ApiParam>
63+
64+
<ApiParam name="cursor" type="string" :required="false">
65+
66+
Pagination cursor for getting the next or previous set of results.
67+
68+
</ApiParam>
69+
70+
</div>
71+
</div>
72+
73+
<div class="params-section">
74+
75+
### Scopes
76+
77+
`wiki.pages:read`
78+
79+
</div>
80+
81+
</div>
82+
83+
<div class="api-right">
84+
85+
<CodePanel title="List workspace wiki pages" :languages="['cURL', 'Python', 'JavaScript']">
86+
<template #curl>
87+
88+
```bash
89+
curl -X GET \
90+
"https://api.plane.so/api/v1/workspaces/my-workspace/pages/?type=public&search=welcome&per_page=20" \
91+
-H "X-API-Key: $PLANE_API_KEY" \
92+
# Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN"
93+
```
94+
95+
</template>
96+
<template #python>
97+
98+
```python
99+
import requests
100+
101+
response = requests.get(
102+
"https://api.plane.so/api/v1/workspaces/my-workspace/pages/",
103+
headers={"X-API-Key": "your-api-key"},
104+
params={"type": "public", "search": "welcome", "per_page": 20},
105+
)
106+
print(response.json())
107+
```
108+
109+
</template>
110+
<template #javascript>
111+
112+
```javascript
113+
const response = await fetch(
114+
"https://api.plane.so/api/v1/workspaces/my-workspace/pages/?type=public&search=welcome&per_page=20",
115+
{
116+
method: "GET",
117+
headers: {
118+
"X-API-Key": "your-api-key",
119+
},
120+
}
121+
);
122+
const data = await response.json();
123+
```
124+
125+
</template>
126+
</CodePanel>
127+
128+
<ResponsePanel status="200">
129+
130+
```json
131+
{
132+
"grouped_by": null,
133+
"sub_grouped_by": null,
134+
"total_count": 4,
135+
"next_cursor": "20:1:0",
136+
"prev_cursor": "20:-1:1",
137+
"next_page_results": false,
138+
"prev_page_results": false,
139+
"count": 4,
140+
"total_pages": 1,
141+
"total_results": 4,
142+
"extra_stats": null,
143+
"results": [
144+
{
145+
"id": "b3478c56-31f6-4f7e-b445-8392a4b26621",
146+
"name": "welcome 3 b",
147+
"owned_by": "5b0af4aa-e310-408a-a480-868429af5701",
148+
"access": 0,
149+
"is_locked": false,
150+
"archived_at": null,
151+
"workspace": "8725ddfa-c181-49f6-9173-97b8d0b7d599",
152+
"created_at": "2026-04-01T15:41:19.062280Z",
153+
"updated_at": "2026-04-07T19:30:39.274060Z",
154+
"logo_props": {},
155+
"parent_id": "a2819c8b-f7ac-4cbd-b971-682726c4f8cc"
156+
}
157+
]
158+
}
159+
```
160+
161+
</ResponsePanel>
162+
163+
</div>
164+
165+
</div>

0 commit comments

Comments
 (0)