List collection pages

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

Return the pages in a collection as full page objects, paginated. You get the membership and the pages behind it in one call, so there's no need to read page_ids from the collection and fetch each page.

Each row is the same page object that List workspace pages returns, with collection_id set to this collection. Like the workspace pages list, this list leaves out pages you can't see. You see a page if it's shared with you, if it's in a private collection that you own or belong to, or if it's outside private collections and you own it or it's public.

The list includes archived pages and nested pages. It's flat: each nested page is its own row, and its parent_id points at its parent.

Rows come back newest page first, by the page's created_at. The list takes no order_by. The sort_order on each row is the page's own field, not its position in the collection. The collection position is the sort_order that Move or reorder a collection page returns.

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 whose pages you want. A collection you can't see returns 404.

Pagination

per_page:optionalinteger

Page size. Defaults to 50, maximum 200.

offset:optionalinteger

Number of rows to skip from the start of the result set. Maximum 10000. Use the next value from the response instead of computing offsets yourself.

count:optionalboolean

Defaults to true. Set to false to skip the COUNT(*) behind total_count. The field is then omitted from the response.

Response shaping

fields:optionalstring

Comma-separated list of fields to return on each row. Fields you don't request are left out of the response instead of coming back as null, so a missing key means you didn't ask for it and null means the value is null. id is always included, whether or not you name it.

By default, rows leave out description_html, description_stripped, and project_ids. Name them, or pass all, to get them.

Pass all to get every requestable field. An unknown field name returns 400 with the list of valid names and the closest match, so a typo is caught instead of being silently ignored.

Requestable here: access, archived_at, collection_id, color, created_at, created_by_id, description_html, description_stripped, external_id, external_source, id, is_global, is_locked, logo_props, name, owned_by_id, parent_id, project_ids, sort_order, updated_at, updated_by_id, view_props.

See Sparse fields.

expand:optionalstring

Comma-separated relations to embed alongside the ids: owned_by (the page's owner), parent (its parent page).

Expanded objects get their own key: ?expand=parent keeps parent_id and adds a parent object next to it, so an id is never replaced by an object. An unknown value returns 400.

?fields= and ?expand= are independent namespaces. Relation names are not valid ?fields= tokens (and vice versa), and an expanded object survives field filtering. For example, ?fields=id,name&expand=parent returns id, name, and parent. See Expanding relations.

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 token scope can't read wiki pages.
404	not_found	No such collection in this workspace, or you can't see it.
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.

List collection pages

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/collections/e1b7c9d3-4a2f-4c86-9d15-3b8f6a0e2c71/pages/?per_page=50" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

response = requests.get(
    "https://api.plane.so/api/v2/workspaces/my-team/collections/e1b7c9d3-4a2f-4c86-9d15-3b8f6a0e2c71/pages/",
    headers={"X-Api-Key": "your-api-key"},
    params={"per_page": 50},
)
print(response.json())

const params = new URLSearchParams({ per_page: "50" });
const response = await fetch(
  `https://api.plane.so/api/v2/workspaces/my-team/collections/e1b7c9d3-4a2f-4c86-9d15-3b8f6a0e2c71/pages/?${params}`,
  {
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

{
  "data": [
    {
      "id": "9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88",
      "name": "Onboarding checklist",
      "access": 0,
      "color": "",
      "is_locked": false,
      "archived_at": null,
      "logo_props": {},
      "view_props": {
        "full_width": false
      },
      "parent_id": null,
      "owned_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "collection_id": "e1b7c9d3-4a2f-4c86-9d15-3b8f6a0e2c71",
      "is_global": true,
      "sort_order": 65535.0,
      "external_id": null,
      "external_source": null,
      "created_at": "2026-01-14T09:22:41.478363Z",
      "updated_at": "2026-01-15T11:02:37.640118Z",
      "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "updated_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430"
    },
    {
      "id": "61c3e8a5-0b9d-4f27-a4e6-c8d2f5b1a097",
      "name": "Engineering handbook",
      "access": 0,
      "color": "",
      "is_locked": true,
      "archived_at": null,
      "logo_props": {},
      "view_props": {
        "full_width": false
      },
      "parent_id": null,
      "owned_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "collection_id": "e1b7c9d3-4a2f-4c86-9d15-3b8f6a0e2c71",
      "is_global": true,
      "sort_order": 75535.0,
      "external_id": null,
      "external_source": null,
      "created_at": "2026-01-10T08:15:09.204771Z",
      "updated_at": "2026-01-12T17:44:51.093326Z",
      "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "updated_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430"
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 2,
  "pagination": {
    "style": "offset"
  }
}