Create a collection

POST/api/v1/workspaces/{workspace_slug}/collections/

Creates a collection. Private collections can only be created by workspace admins when the feature is available. The creator of a private collection is automatically added as a member with edit access.

Path Parameters

workspace_slug:requiredstring

The workspace slug.

Body Parameters

name:optionalstring

The collection name. Defaults to an empty string.

access:optionalinteger

0 for public (default) or 1 for private.

logo_props:optionalobject

Logo or emoji properties. Defaults to an empty object.

Scopes

write or wiki.pages:write

Create a collection

curl -X POST "https://api.plane.so/api/v1/workspaces/my-workspace/collections/" \
  -H "X-API-Key: $PLANE_API_KEY" -H "Content-Type: application/json" \
  -d '{"name":"Product docs","access":0,"logo_props":{"emoji":"📚"}}'

import requests

response = requests.post(
    "https://api.plane.so/api/v1/workspaces/my-workspace/collections/",
    headers={"X-API-Key": "your-api-key"},
    json={"name": "Product docs", "access": 0, "logo_props": {"emoji": "📚"}},
)
print(response.json())

// Run this example server-side. Browser apps must call your backend to keep the API key secret.
const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspace/collections/", {
  method: "POST",
  headers: { "X-API-Key": process.env.PLANE_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({ name: "Product docs", access: 0, logo_props: { emoji: "📚" } }),
});
console.log(await response.json());

Response201

{
  "id": "0a8a3e6a-3c32-49c7-bbb5-b7a8e32c2f10",
  "name": "Product docs",
  "owned_by_id": "d2f1b470-55e8-4e7a-8a61-7fc695bc1a4f",
  "access": 0,
  "current_user_access": null,
  "has_pages": false,
  "is_default": false,
  "is_global": true,
  "logo_props": { "emoji": "📚" },
  "sort_order": 65535.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"
}