Skip to content

List project page templates ​

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

Return the page templates that belong to one project, as a paginated list.

The list holds this project's templates only. It doesn't include workspace-level templates, which are on List workspace page templates. Turning on workspace governance doesn't move existing project page templates, so they stay in this list.

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.

project_id:requiredstring

The project whose page templates you want to list. Accepts the project UUID or its identifier, for example ENG.

Query parameters ​

Filters combine with AND.

name:optionalstring

Return templates whose name matches exactly, ignoring case.

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 ​

StatusCodeCause
400invalid_request?fields= names an unknown field.
401unauthorizedMissing or invalid credentials.
402payment_requiredPage templates aren't in your plan, or the feature is switched off for this workspace.
403forbiddenYour role or token scope can't read this project's page templates.
404not_foundNo such workspace or project, 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.
List project page templates
bash
curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/page-templates/?per_page=50" \
  -H "X-Api-Key: $PLANE_API_KEY"
Response200
json
{
  "data": [
    {
      "id": "9e1c7a52-3b4d-4f86-a0d2-5c8e7b1f3a94",
      "name": "Incident postmortem",
      "short_description": "Timeline, impact, root cause, and follow-ups",
      "template_type": "page",
      "is_published": false,
      "short_id": "m5v8c1",
      "slug": "incident-postmortem",
      "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
    },
    {
      "id": "1a7d3e9b-5c2f-4b80-9e46-8d0c2f7a1b53",
      "name": "Design review",
      "short_description": "Context, options considered, and the decision",
      "template_type": "page",
      "is_published": false,
      "short_id": "d2h6ne",
      "slug": "design-review",
      "project_id": "4af68566-94a4-4eb3-94aa-50dc9427067b",
      "created_at": "2026-01-09T11:37:54.019362Z",
      "updated_at": "2026-01-09T11:37:54.019362Z",
      "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "updated_by_id": null
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 2,
  "pagination": {
    "style": "offset"
  }
}