Search pages for a collection

GET/api/v2/workspaces/{slug}/collections/{pk}/pages-search/

Collections group wiki pages in a workspace.

Path parameters

slug:requiredstring

The workspace slug. It appears in your Plane URLs. In https://app.plane.so/my-team/projects/, the slug is my-team.

pk:requiredstring (uuid)

The collection id.

Response shaping

fields:optionalstring

Comma-separated list of fields to return. Fields you don't request are left out of each row instead of coming back as null. id is always included. Pass all to get every requestable field.

An unknown field name returns 400 with the list of valid names, so a typo is caught instead of being silently ignored. See Sparse fields.

Requestable here: id, logo_props, name.

Scopes

wiki.pages:read

Errors

Status	Code	Cause
401	unauthorized	Missing or invalid credentials.
402	payment_required	The feature this endpoint belongs to isn't enabled on your plan or is switched off.
403	forbidden	Your role or token scope doesn't allow this.
404	not_found	No such resource, or it's outside your tenant.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
429	rate_limited	Throttled. Honor the Retry-After header before retrying.

Search pages for a collection

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/collections/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/pages-search/" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

response = requests.get(
    "https://api.plane.so/api/v2/workspaces/my-team/collections/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/pages-search/",
    headers={"X-Api-Key": "your-api-key"},
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/collections/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/pages-search/",
  {
    method: "GET",
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

{
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "logo_props": null,
  "name": "Example name"
}