Search addable collection pages

GET/api/v1/workspaces/{workspace_slug}/collections/{collection_id}/pages-search/

Returns eligible root pages that are not already assigned to the collection. Results respect page and private collection permissions. Without search, the endpoint returns at most 10 results. With search, it performs a case-insensitive page-name search without that limit.

Path Parameters

workspace_slug:requiredstring

The workspace slug.

collection_id:requireduuid

The destination collection ID.

Query Parameters

search:optionalstring

A page-name search string.

Scopes

read or wiki.pages:read

Search addable collection pages

curl "https://api.plane.so/api/v1/workspaces/my-workspace/collections/collection-uuid/pages-search/?search=API" -H "X-API-Key: $PLANE_API_KEY"

import requests
url = "https://api.plane.so/api/v1/workspaces/my-workspace/collections/collection-uuid/pages-search/"
print(requests.get(url, headers={"X-API-Key": "your-api-key"}, params={"search": "API"}).json())

// Run this example server-side. Browser apps must call your backend to keep the API key secret.
const url =
  "https://api.plane.so/api/v1/workspaces/my-workspace/collections/collection-uuid/pages-search/?search=API";
const response = await fetch(url, { headers: { "X-API-Key": process.env.PLANE_API_KEY } });
console.log(await response.json());

Response200

[
  {
    "id": "ea8ccdab-1cf4-448b-8205-51e4b98d82b8",
    "name": "API guide",
    "logo_props": { "emoji": "📘" }
  }
]