Create work item page link

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

Link a page to a work item.

Path Parameters

issue_id:requiredstring

Issue ID

project_id:requiredstring

Project ID

slug:requiredstring

Workspace slug

work_item_id:requiredstring

Work item id.

Body Parameters

page_id:requiredstring

ID of the page to link to the work item

Scopes

API key authentication or an OAuth token with equivalent access.

Create work item page link

curl -X POST \
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/pages/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "page_id": "550e8400-e29b-41d4-a716-446655440000"
}'

import requests

response = requests.post(
    "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/pages/",
    headers={"X-API-Key": "your-api-key"},
    json={
      "page_id": "550e8400-e29b-41d4-a716-446655440000"
    }
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/550e8400-e29b-41d4-a716-446655440000/work-items/550e8400-e29b-41d4-a716-446655440001/pages/",
  {
    method: "POST",
    headers: {
      "X-API-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      page_id: "550e8400-e29b-41d4-a716-446655440000",
    }),
  }
);
const data = await response.json();

Response201

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "page": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Example Name",
    "description_html": "<p>Example content</p>",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z",
    "created_by": "550e8400-e29b-41d4-a716-446655440000",
    "is_global": false,
    "logo_props": {}
  },
  "issue": "550e8400-e29b-41d4-a716-446655440000",
  "project": "550e8400-e29b-41d4-a716-446655440000",
  "workspace": "550e8400-e29b-41d4-a716-446655440000",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z",
  "created_by": "550e8400-e29b-41d4-a716-446655440000"
}