Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -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" },
Expand Down
165 changes: 165 additions & 0 deletions docs/api-reference/page/list-workspace-pages.md
Original file line number Diff line number Diff line change
@@ -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

<div class="api-endpoint-badge">
<span class="method get">GET</span>
<span class="path">/api/v1/workspaces/{workspace_slug}/pages/</span>
</div>

<div class="api-two-column">
<div class="api-left">

List all wiki pages in a workspace with optional filtering and search.

<div class="params-section">

### Path Parameters
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix heading-level jump to satisfy markdown lint (MD001).

After the H1 on Line 7, Lines 21/36/75 should be H2, not H3. This can fail docs lint checks.

💡 Proposed fix
-### Path Parameters
+## Path Parameters
...
-### Query Parameters
+## Query Parameters
...
-### Scopes
+## Scopes

Also applies to: 36-36, 75-75

🧰 Tools
🪛 markdownlint-cli2 (0.22.0)

[warning] 21-21: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3

(MD001, heading-increment)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/api-reference/page/list-workspace-pages.md` at line 21, Change the three
headings currently written as H3 ("### Path Parameters" and the other two
headings at the same locations) to H2 ("## …") so they follow the H1 in the
document and satisfy MD001; specifically update the headings labeled "Path
Parameters" and the other headings at the same spots (previously prefixed with
###) to use ## instead.


<div class="params-list">

<ApiParam name="workspace_slug" type="string" :required="true">

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`.

</ApiParam>

</div>
</div>

<div class="params-section">

### Query Parameters

<div class="params-list">

<ApiParam name="type" type="string" :required="false">

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

</ApiParam>

<ApiParam name="search" type="string" :required="false">

Case-insensitive search on page title.

</ApiParam>

<ApiParam name="per_page" type="integer" :required="false">

Number of results per page. Defaults to `20`, maximum `100`.

</ApiParam>

<ApiParam name="cursor" type="string" :required="false">

Pagination cursor for getting the next or previous set of results.

</ApiParam>

</div>
</div>

<div class="params-section">

### Scopes

`wiki.pages:read`

</div>

</div>

<div class="api-right">

<CodePanel title="List workspace wiki pages" :languages="['cURL', 'Python', 'JavaScript']">
<template #curl>

```bash
curl -X GET \
"https://api.plane.so/api/v1/workspaces/my-workspace/pages/?type=public&search=welcome&per_page=20" \
-H "X-API-Key: $PLANE_API_KEY" \
# Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN"
```

</template>
<template #python>

```python
import requests

response = requests.get(
"https://api.plane.so/api/v1/workspaces/my-workspace/pages/",
headers={"X-API-Key": "your-api-key"},
params={"type": "public", "search": "welcome", "per_page": 20},
)
print(response.json())
```

</template>
<template #javascript>

```javascript
const response = await fetch(
"https://api.plane.so/api/v1/workspaces/my-workspace/pages/?type=public&search=welcome&per_page=20",
{
method: "GET",
headers: {
"X-API-Key": "your-api-key",
},
}
);
const data = await response.json();
```

</template>
</CodePanel>

<ResponsePanel status="200">

```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"
}
]
}
```

</ResponsePanel>

</div>

</div>
Loading