Create a work item page

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

Link a page to a work item. The call returns 201 with the new link. If you plan to remove the link later, keep its id. Delete a work item page takes the link id, not the page id.

You can link any page in the workspace: a page in this project, a page in another project, or a workspace (wiki) page. Each page links to a work item at most once, so linking the same page again returns 409 conflict.

The API doesn't check whether you can see the page itself. You can link a private page that belongs to someone else, and ?expand=page on the link then returns that page's name.

Linking a page adds an entry to the work item's activity. It doesn't change the 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 to link the page to. Accepts the work item UUID or its ENG-123 identifier.

Body parameters

page_id:requiredstring (uuid)

The page to link. It must be a page in this workspace. A page id from another workspace, or one that doesn't exist, returns 400 with an errors entry for page_id.

Response shaping

fields:optionalstring

Comma-separated list of fields to return. 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. An unknown value returns 400. See Expanding relations.

Scopes

projects.work_items:write

Errors

Status	Code	Cause
400	invalid_request	page_id is missing, isn't a UUID, or isn't a page in this workspace.
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 create 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.
409	conflict	The page is already linked to this work item.
413	payload_too_large	The request body is over the size limit.
415	unsupported_media_type	The Content-Type isn't one this endpoint accepts.
429	rate_limited	Throttled. Honor the Retry-After header before retrying.

Create a work item page

curl -X POST \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/work-items/5d2a8e47-1c3b-4f96-b0e8-7a4c9d2f1b63/pages/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "page_id": "9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88"
}'

import requests

response = requests.post(
    "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"},
    json={"page_id": "9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88"},
)
link = response.json()
print(link["id"])

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/",
  {
    method: "POST",
    headers: {
      "X-Api-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ page_id: "9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88" }),
  },
);
const link = await response.json();

Response201

{
  "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
}

Response409

{
  "type": "conflict",
  "code": "conflict",
  "detail": "That page is already linked to this work item."
}

Response400

{
  "type": "invalid_request",
  "code": "invalid_request",
  "detail": "One or more fields failed validation.",
  "errors": [
    {
      "field": "page_id",
      "code": "does_not_exist",
      "message": "Invalid pk \"0b1e5c7a-3d92-4f86-a4e1-6c8d2b9f7a05\" - object does not exist."
    }
  ]
}