Skip to content

Get a workspace work item template ​

GET/api/v2/workspaces/{slug}/work-item-templates/{pk}/

Workspace work item templates pre-fill new work items across projects. Read a single workspace work item template by id.

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.

pk:requiredstring (uuid)

The workspace work item template 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. id is always included. Pass all to get every requestable field. An unknown field name returns 400. See Sparse fields.

Requestable here: created_at, created_by_id, description_html, id, is_published, name, short_description, short_id, slug, template_data, template_type, updated_at, updated_by_id.

Scopes ​

templates.work_items:read

Errors ​

StatusCodeCause
401unauthorizedMissing or invalid credentials.
403forbiddenYour token scope doesn't allow this.
404not_foundNo such resource, or it's outside your tenant.
406not_acceptableThe Accept header asks for a representation the API can't produce.
429rate_limitedThrottled. Honor the Retry-After header before retrying.
Get a workspace work item template
bash
curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/work-item-templates/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/" \
  -H "X-Api-Key: $PLANE_API_KEY"
Response200
json
{
  "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,
  "description_html": "<p>Details go here.</p>",
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "is_published": false,
  "name": "Example name",
  "short_description": "example",
  "short_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "slug": "my-team",
  "template_data": {},
  "template_type": "example"
}
Response404
json
{
  "type": "not_found",
  "code": "not_found",
  "detail": "No workspace work item template matches the given query."
}