List collections

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

Returns all public and permitted private collections in sort order. A private collection is included when the caller owns it, is a workspace admin, or is an explicit collection member.

Path Parameters

workspace_slug:requiredstring

The workspace slug.

Scopes

read or wiki.pages:read

List collections

curl "https://api.plane.so/api/v1/workspaces/my-workspace/collections/" \
  -H "X-API-Key: $PLANE_API_KEY"

import requests

response = requests.get(
    "https://api.plane.so/api/v1/workspaces/my-workspace/collections/",
    headers={"X-API-Key": "your-api-key"},
)
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/", {
  headers: { "X-API-Key": process.env.PLANE_API_KEY },
});
console.log(await response.json());

Response200

[
  {
    "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": true,
    "is_default": false,
    "is_global": true,
    "logo_props": {},
    "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"
  }
]