Get a work item page

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

Retrieve one link between a work item and a page. {pk} is the link id from the list or the create response. A page id in its place returns 404.

The link carries only ids. Add ?expand=page for the page's name and state, or read the full page from Get a project page or Get a workspace page.

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.

pk:requiredstring (uuid)

The link id. A link that belongs to another work item returns 404.

Response shaping

fields:optionalstring

Comma-separated list of fields to return. Unrequested keys are omitted from the response, not returned as null, so absent means "not requested" and null means "actually null". id always comes back whether or not you name it.

Pass all for every requestable field. An unknown name is a 400 that lists the valid set and suggests the closest match, so a typo can't silently cost you the saving.

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 is 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 is a 400.

?fields= and ?expand= are independent namespaces. Relation names are not valid ?fields= tokens (and vice versa), and an expanded object survives field filtering. 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, work item, or link, the link belongs to another work item, or you can't see the work item.
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.

Get a work item page

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/c4e8a1f2-7b3d-4e59-9a06-2f1d8c5b7e34/?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/c4e8a1f2-7b3d-4e59-9a06-2f1d8c5b7e34/",
    headers={"X-Api-Key": "your-api-key"},
    params={"expand": "page"},
)
print(response.json())

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/c4e8a1f2-7b3d-4e59-9a06-2f1d8c5b7e34/?expand=page",
  {
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

{
  "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": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "page": {
    "id": "9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88",
    "name": "Login redirect design",
    "access": 0,
    "is_locked": false,
    "archived_at": null
  }
}

Response404

{
  "type": "not_found",
  "code": "not_found",
  "detail": "Work item not found."
}