List project pages

GET/api/v2/workspaces/{slug}/projects/{project_id}/pages/

List the project pages you can see. Project pages are the documents that live inside a project. Results are scoped to the path and to what your token is allowed to read.

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.

project_id:requiredstring

The project the resource belongs to. Accepts the project UUID or its bare identifier, for example ENG.

Query parameters

access:optionalinteger

Filter by access: 0 for public, 1 for private.

collection_id:optionalstring (uuid)

Filter by collection_id.

count:optionalboolean

Set to false to skip the COUNT(*) query behind total_count. The response then leaves out total_count.

external_id:optionalstring

Filter by external_id.

external_source:optionalstring

Filter by external_source.

is_global:optionalboolean

Filter by is_global.

is_locked:optionalboolean

Filter by is_locked.

offset:optionalinteger

Number of rows to skip from the start of the result set.

order_by:optionalstring

Field to sort the list by. Prefix it with - for descending order, for example -created_at. Orders on computed fields sort by their logical order and use the default offset pagination.

owned_by_id:optionalstring (uuid)

Filter by owned_by_id.

paginate:optionalstring

Set to cursor to switch to the keyset cursor envelope, which skips the COUNT query and is better for paging deep into a list. Leave it out to get the default offset envelope with total_count.

One of cursor.

parent_id:optionalstring (uuid)

Filter by parent_id.

per_page:optionalinteger

Page size (max 200).

search:optionalstring

A search term.

type:optionalstring

Filter by page type. One of all, archived, private, public, shared.

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.

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

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.

expand:optionalstring

Comma-separated relations to embed: owned_by, parent.

Expanded objects get their own key: ?expand=state keeps state_id and adds a state object next to it. ?fields= and ?expand= work independently. Naming a relation in ?fields= returns 400, and field filtering never removes an expanded object. See Expanding relations.

Scopes

projects.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.

List project pages

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/pages/" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

response = requests.get(
    "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/pages/",
    headers={"X-Api-Key": "your-api-key"},
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/pages/",
  {
    method: "GET",
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

{
  "data": [
    {
      "access": 0,
      "archived_at": null,
      "collection_id": null,
      "color": "#3f76ff",
      "created_at": "2026-01-14T09:22:41.478363Z",
      "updated_at": "2026-01-14T09:22:41.478363Z",
      "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "updated_by_id": null,
      "external_id": null,
      "external_source": null,
      "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
      "is_global": false,
      "is_locked": false,
      "logo_props": null,
      "name": "Example name",
      "owned_by_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
      "parent_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
      "sort_order": 65535,
      "view_props": null
    }
  ],
  "next": 1,
  "pagination": {
    "style": "offset"
  },
  "previous": 1,
  "total_count": 3
}