Get a project page template

GET/api/v2/workspaces/{slug}/projects/{project_id}/page-templates/{pk}/

Retrieve one project page template by id. The response always includes description_html and the full template_data seed, which list rows leave out by default.

The template must belong to the project in the path. A workspace page template's id, or a template from another project, returns 404.

Reads work in a workspace with workspace governance turned on, where writes to this route return 409 templates_managed_at_workspace.

Path Parameters

slug:requiredstring

The workspace slug. It appears in your Plane URLs, so in https://app.plane.so/my-team/projects/ the slug is my-team.

project_id:requiredstring

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

pk:requiredstring (uuid)

The id of the page template to retrieve.

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, description_html, id, is_published, name, project_id, short_description, short_id, slug, template_data, template_type, updated_at, updated_by_id.

See Sparse fields.

Scopes

templates.pages:read

Errors

Status	Code	Cause
400	invalid_request	?fields= names an unknown field.
401	unauthorized	Missing or invalid credentials.
402	payment_required	Page templates aren't in your plan, or the feature is switched off for this workspace.
403	forbidden	Your role or token scope can't read this project's page templates.
404	not_found	No page template with this id in this project. Workspace templates and other projects' templates also return 404.
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 project page template

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/page-templates/9e1c7a52-3b4d-4f86-a0d2-5c8e7b1f3a94/" \
  -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"
    "/page-templates/9e1c7a52-3b4d-4f86-a0d2-5c8e7b1f3a94/",
    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" +
    "/page-templates/9e1c7a52-3b4d-4f86-a0d2-5c8e7b1f3a94/",
  {
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

{
  "id": "9e1c7a52-3b4d-4f86-a0d2-5c8e7b1f3a94",
  "name": "Incident postmortem",
  "short_description": "Timeline, impact, root cause, and follow-ups",
  "description_html": "<p>Fill this in within 48 hours of an incident.</p>",
  "template_type": "page",
  "is_published": false,
  "short_id": "m5v8c1",
  "slug": "incident-postmortem",
  "project_id": "4af68566-94a4-4eb3-94aa-50dc9427067b",
  "template_data": {
    "name": "Postmortem",
    "description_html": "<h2>Timeline</h2><p></p><h2>Impact</h2><p></p><h2>Root cause</h2><p></p><h2>Follow-ups</h2><p></p>",
    "color": "#e5484d",
    "parent": {
      "id": "c2f5a8d1-7e3b-4c96-8a14-0b9d6e2f5c71",
      "project_id": "4af68566-94a4-4eb3-94aa-50dc9427067b",
      "project_identifier": "ENG"
    },
    "view_props": {
      "full_width": true
    },
    "logo_props": {}
  },
  "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
}

Response404

{
  "type": "not_found",
  "code": "not_found",
  "detail": "The requested resource was not found."
}