List work item pages

GET/api/v2/workspaces/{slug}/projects/{project_id}/work-items/{work_item_id}/pages/

Return the page links on one work item as a paginated list, newest first. Each row is a link, so id is the link id and page_id is the page. Add ?expand=page to get each page's name, access, lock, and archive status in the same call.

To check whether one page is already linked, filter with ?page_id=. An empty data array means it isn't.

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 work item's project. Accepts the project UUID or its bare identifier, for example ENG.

work_item_id:requiredstring

The work item. Accepts the work item UUID or its ENG-123 identifier.

Query parameters

page_id:optionalstring (uuid)

Return only the link to this page. A work item links to a page at most once, so the result has zero or one row.

Ordering

order_by:optionalstring

Field to sort by. Prefix with - for descending. Defaults to -created_at, the most recent link first.

• created_at, -created_at
• id, -id

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.

paginate:optionalstring

Set to cursor to switch to the keyset envelope, which skips the COUNT query and returns next_cursor and has_more instead of next and total_count. Leave it out to get the default offset envelope.

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.

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: created_at, created_by_id, id, page_id, project_id, updated_at, updated_by_id, work_item_id.

See Sparse fields.

expand:optionalstring

Comma-separated relations to embed alongside the ids: page (the linked page, with id, name, access, is_locked, and archived_at).

Expansion adds a separate key: ?expand=page keeps page_id and adds a page 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&expand=page returns id and page. See Expanding relations.

Scopes

projects.work_items: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 can't read pages in this project.
404	not_found	No such project or work item, the work item isn't in this project, 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 work item pages

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/work-items/5d2a8e47-1c3b-4f96-b0e8-7a4c9d2f1b63/pages/?expand=page" \
  -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"
    "/work-items/5d2a8e47-1c3b-4f96-b0e8-7a4c9d2f1b63/pages/",
    headers={"X-Api-Key": "your-api-key"},
    params={"expand": "page"},
)
for link in response.json()["data"]:
    print(link["page"]["name"])

const params = new URLSearchParams({ expand: "page" });
const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b" +
    `/work-items/5d2a8e47-1c3b-4f96-b0e8-7a4c9d2f1b63/pages/?${params}`,
  {
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

{
  "data": [
    {
      "id": "c4e8a1f2-7b3d-4e59-9a06-2f1d8c5b7e34",
      "page_id": "9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88",
      "work_item_id": "5d2a8e47-1c3b-4f96-b0e8-7a4c9d2f1b63",
      "project_id": "4af68566-94a4-4eb3-94aa-50dc9427067b",
      "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,
      "page": {
        "id": "9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88",
        "name": "Login redirect design",
        "access": 0,
        "is_locked": false,
        "archived_at": null
      }
    },
    {
      "id": "0a6f3d92-4e1b-4c78-b5a2-9d8e7f6c1b40",
      "page_id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
      "work_item_id": "5d2a8e47-1c3b-4f96-b0e8-7a4c9d2f1b63",
      "project_id": "4af68566-94a4-4eb3-94aa-50dc9427067b",
      "created_at": "2026-01-13T16:04:02.911204Z",
      "updated_at": "2026-01-13T16:04:02.911204Z",
      "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "updated_by_id": null,
      "page": {
        "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
        "name": "Auth service runbook",
        "access": 0,
        "is_locked": true,
        "archived_at": null
      }
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 2,
  "pagination": {
    "style": "offset"
  }
}