List workspace page templates

GET/api/v2/workspaces/{slug}/page-templates/

Return the workspace's page templates as a paginated list. Use it to build a template picker or to find a template's id by name.

The list holds workspace-level templates only. Templates that belong to a project are on List project page templates, and neither list includes the other's rows.

Rows leave out description_html and template_data unless you ask for them with ?fields=.

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.

Query parameters

Filters combine with AND.

name:optionalstring

Return templates whose name matches exactly, ignoring case. ?name=weekly sync matches Weekly sync.

is_published:optionalboolean

Return only published (true) or only unpublished (false) templates.

short_id:optionalstring

Return the template with this short_id.

search:optionalstring

A search term matched against name and short_description.

Ordering

order_by:optionalstring

Field to sort by. Prefix with - for descending. Defaults to -created_at, newest first.

• created_at, -created_at
• id, -id

Both orderings work with cursor pagination.

Pagination

per_page:optionalinteger

Page size. Defaults to 50, maximum 200.

offset:optionalinteger

Number of rows to skip from the start of the result set. Maximum 10000. Use the next value from the response instead of computing offsets yourself.

paginate:optionalstring

Set to cursor to switch to the keyset envelope, which skips the COUNT query and returns next_cursor and has_more instead of next and total_count. Leave it out to get the default offset envelope.

count:optionalboolean

Defaults to true. Set to false to skip the COUNT(*) behind total_count. The field is then omitted from the response.

Response shaping

fields:optionalstring

Comma-separated list of fields to return on each row. 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.

description_html and template_data are deferred on list rows. Name them, or pass all, to include them.

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 workspace's page templates.
404	not_found	No such workspace, or it's outside your tenant.
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.

List workspace page templates

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/page-templates/?search=sync&per_page=50" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

response = requests.get(
    "https://api.plane.so/api/v2/workspaces/my-team/page-templates/",
    headers={"X-Api-Key": "your-api-key"},
    params={"search": "sync", "per_page": 50},
)
print(response.json())

const params = new URLSearchParams({ search: "sync", per_page: "50" });
const response = await fetch(
  `https://api.plane.so/api/v2/workspaces/my-team/page-templates/?${params}`,
  {
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

{
  "data": [
    {
      "id": "3d8b2f4e-6a1c-4e57-9b02-7c5d1e8f4a36",
      "name": "Weekly sync",
      "short_description": "Agenda and notes for the weekly team sync",
      "template_type": "page",
      "is_published": false,
      "short_id": "k3x9p2",
      "slug": "weekly-sync",
      "project_id": null,
      "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
    },
    {
      "id": "7f2a9c4d-1e6b-4a83-8d57-3b0e9f6c2a18",
      "name": "Sprint retro",
      "short_description": "What went well, what didn't, and actions",
      "template_type": "page",
      "is_published": false,
      "short_id": "r8t4wz",
      "slug": "sprint-retro",
      "project_id": null,
      "created_at": "2026-01-12T15:08:19.204117Z",
      "updated_at": "2026-01-13T10:41:02.778930Z",
      "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "updated_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430"
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 2,
  "pagination": {
    "style": "offset"
  }
}

Response200

{
  "data": [
    {
      "id": "3d8b2f4e-6a1c-4e57-9b02-7c5d1e8f4a36",
      "name": "Weekly sync",
      "template_data": {
        "name": "Weekly sync notes",
        "description_html": "<h2>Agenda</h2><ul><li><p>Updates</p></li><li><p>Blockers</p></li></ul>",
        "color": "#3f76ff",
        "parent": {},
        "view_props": {
          "full_width": false
        },
        "logo_props": {
          "emoji": {
            "value": "128221"
          },
          "in_use": "emoji"
        }
      }
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 1,
  "pagination": {
    "style": "offset"
  }
}