-
Notifications
You must be signed in to change notification settings - Fork 22
WIKI-1068: document page and collection APIs #320
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
iam-vipin
wants to merge
4
commits into
master
Choose a base branch
from
docs-page-update-api
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| --- | ||
| title: Add a collection member | ||
| description: Grant a workspace user access to a private Plane collection. | ||
| keywords: plane, plane api, rest api, collection members, add member, private collection | ||
| --- | ||
|
|
||
| # Add a collection member | ||
|
|
||
| <div class="api-endpoint-badge"><span class="method post">POST</span><span class="path">/api/v1/workspaces/{workspace_slug}/collections/{collection_id}/members/</span></div> | ||
|
|
||
| <div class="api-two-column"><div class="api-left"> | ||
|
|
||
| Adds an explicit member to a private collection. The caller must be able to manage the collection. | ||
|
|
||
| ### Path Parameters | ||
|
|
||
| <ApiParam name="workspace_slug" type="string" :required="true">The workspace slug.</ApiParam> | ||
| <ApiParam name="collection_id" type="uuid" :required="true">The collection ID.</ApiParam> | ||
|
|
||
| ### Body Parameters | ||
|
|
||
| <ApiParam name="member" type="uuid" :required="true">The workspace user's ID.</ApiParam> | ||
| <ApiParam name="access" type="integer" :required="false">`0` (view, default), `1` (comment), or `2` (edit).</ApiParam> | ||
|
|
||
| ### OAuth scope | ||
|
|
||
| `write` or `wiki.pages:write` | ||
|
|
||
| </div><div class="api-right"> | ||
| <CodePanel title="Add a collection member" :languages="['cURL', 'Python', 'JavaScript']"><template #curl> | ||
|
|
||
| ```bash | ||
| curl -X POST "https://api.plane.so/api/v1/workspaces/my-workspace/collections/collection-uuid/members/" \ | ||
| -H "X-API-Key: $PLANE_API_KEY" -H "Content-Type: application/json" \ | ||
| -d '{"member":"6f356c85-bb22-47e0-b8b1-cf18aa6adad3","access":0}' | ||
| ``` | ||
|
|
||
| </template><template #python> | ||
|
|
||
| ```python | ||
| import requests | ||
| url = "https://api.plane.so/api/v1/workspaces/my-workspace/collections/collection-uuid/members/" | ||
| response = requests.post(url, headers={"X-API-Key": "your-api-key"}, json={"member": "6f356c85-bb22-47e0-b8b1-cf18aa6adad3", "access": 0}) | ||
| print(response.json()) | ||
| ``` | ||
|
|
||
| </template><template #javascript> | ||
|
|
||
| ```javascript | ||
| const url = "https://api.plane.so/api/v1/workspaces/my-workspace/collections/collection-uuid/members/"; | ||
| const response = await fetch(url, { | ||
| method: "POST", | ||
| headers: { "X-API-Key": "your-api-key", "Content-Type": "application/json" }, | ||
| body: JSON.stringify({ member: "6f356c85-bb22-47e0-b8b1-cf18aa6adad3", access: 0 }), | ||
| }); | ||
| console.log(await response.json()); | ||
| ``` | ||
|
|
||
| </template></CodePanel> | ||
| <ResponsePanel status="201"> | ||
|
|
||
| ```json | ||
| { | ||
| "id": "4edec253-26f4-4667-8f52-9488dca1c620", | ||
| "collection": "0a8a3e6a-3c32-49c7-bbb5-b7a8e32c2f10", | ||
| "member": "6f356c85-bb22-47e0-b8b1-cf18aa6adad3", | ||
| "access": 0, | ||
| "workspace": "95d1f03f-16e5-4807-a8c5-ec0c7cf0e4ab", | ||
| "created_at": "2026-08-18T10:00:00Z", | ||
| "updated_at": "2026-08-18T10:00:00Z", | ||
| "created_by": "d2f1b470-55e8-4e7a-8a61-7fc695bc1a4f", | ||
| "updated_by": "d2f1b470-55e8-4e7a-8a61-7fc695bc1a4f" | ||
| } | ||
| ``` | ||
|
|
||
| </ResponsePanel></div></div> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| --- | ||
| title: Add pages to a collection | ||
| description: Add one or more Plane workspace page trees to a collection. | ||
| keywords: plane, plane api, rest api, collection pages, add pages, page placement | ||
| --- | ||
|
|
||
| # Add pages to a collection | ||
|
|
||
| <div class="api-endpoint-badge"><span class="method post">POST</span><span class="path">/api/v1/workspaces/{workspace_slug}/collections/{collection_id}/pages/</span></div> | ||
|
|
||
| <div class="api-two-column"><div class="api-left"> | ||
|
|
||
| Adds each selected page and its sub-pages. Adding to a private collection makes the page tree private; adding an owned | ||
| private page to a public collection makes it public. Private collections accept only root pages. | ||
|
|
||
| ### Path Parameters | ||
|
|
||
| <ApiParam name="workspace_slug" type="string" :required="true">The workspace slug.</ApiParam> | ||
| <ApiParam name="collection_id" type="uuid" :required="true">The destination collection ID.</ApiParam> | ||
|
|
||
| ### Body Parameters | ||
|
|
||
| <ApiParam name="page_ids" type="uuid[]" :required="true">One or more workspace page IDs.</ApiParam> | ||
| <ApiParam name="sort_orders" type="object" :required="false">Page-ID keys mapped to numeric sort orders. Every key must occur in `page_ids`.</ApiParam> | ||
| <ApiParam name="placement" type="object" :required="false">Placement with `type`: `append`, `before`, or `after`; optional `parent_id`; and required `target_page_id` for `before` or `after`. Before/after accepts exactly one page.</ApiParam> | ||
|
|
||
| `placement` takes precedence over `sort_orders`. An `append` placement accepts multiple pages and preserves their order | ||
| from `page_ids`. | ||
|
|
||
| ### OAuth scope | ||
|
|
||
| `write` or `wiki.pages:write` | ||
|
|
||
| </div><div class="api-right"> | ||
| <CodePanel title="Add pages to a collection" :languages="['cURL', 'Python', 'JavaScript']"><template #curl> | ||
|
|
||
| ```bash | ||
| curl -X POST "https://api.plane.so/api/v1/workspaces/my-workspace/collections/collection-uuid/pages/" \ | ||
| -H "X-API-Key: $PLANE_API_KEY" -H "Content-Type: application/json" \ | ||
| -d '{"page_ids":["ea8ccdab-1cf4-448b-8205-51e4b98d82b8"],"placement":{"type":"append","parent_id":null}}' | ||
| ``` | ||
|
|
||
| </template><template #python> | ||
|
|
||
| ```python | ||
| import requests | ||
| url = "https://api.plane.so/api/v1/workspaces/my-workspace/collections/collection-uuid/pages/" | ||
| payload = {"page_ids": ["ea8ccdab-1cf4-448b-8205-51e4b98d82b8"], "placement": {"type": "append", "parent_id": None}} | ||
| print(requests.post(url, headers={"X-API-Key": "your-api-key"}, json=payload).json()) | ||
| ``` | ||
|
|
||
| </template><template #javascript> | ||
|
|
||
| ```javascript | ||
| const url = "https://api.plane.so/api/v1/workspaces/my-workspace/collections/collection-uuid/pages/"; | ||
| const response = await fetch(url, { | ||
| method: "POST", | ||
| headers: { "X-API-Key": "your-api-key", "Content-Type": "application/json" }, | ||
| body: JSON.stringify({ | ||
| page_ids: ["ea8ccdab-1cf4-448b-8205-51e4b98d82b8"], | ||
| placement: { type: "append", parent_id: null }, | ||
| }), | ||
| }); | ||
| console.log(await response.json()); | ||
| ``` | ||
|
|
||
| </template></CodePanel> | ||
| <ResponsePanel status="200"> | ||
|
|
||
| ```json | ||
| [ | ||
| { | ||
| "id": "55ebf2cc-61ba-478a-b88c-88db969e29dc", | ||
| "collection": "0a8a3e6a-3c32-49c7-bbb5-b7a8e32c2f10", | ||
| "page": "ea8ccdab-1cf4-448b-8205-51e4b98d82b8", | ||
|
iam-vipin marked this conversation as resolved.
|
||
| "workspace": "95d1f03f-16e5-4807-a8c5-ec0c7cf0e4ab", | ||
| "sort_order": 65535.0, | ||
| "created_at": "2026-08-18T10:00:00Z", | ||
| "updated_at": "2026-08-18T10:00:00Z", | ||
| "created_by": "d2f1b470-55e8-4e7a-8a61-7fc695bc1a4f", | ||
| "updated_by": "d2f1b470-55e8-4e7a-8a61-7fc695bc1a4f" | ||
| } | ||
| ] | ||
| ``` | ||
|
|
||
| </ResponsePanel></div></div> | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.