Skip to content

List template categories ​

GET/api/v2/template-categories/

Return the template category catalog as a paginated list, sorted by sort_order. Use it to label project templates by category, or to find the id you pass to ?category_id= on List project templates.

The catalog is global, so the path has no workspace. By default the list holds active categories only. Pass ?is_active=false for the inactive ones.

Query parameters ​

Filters combine with AND.

is_active:optionalboolean

Return only active (true) or only inactive (false) categories. When you leave it out, the list returns active categories only.

name:optionalstring

Return the category whose name matches exactly, ignoring case. ?name=engineering matches Engineering.

slug:optionalstring

Return the category with this exact slug.

search:optionalstring

A search term matched against name and description.

Ordering ​

order_by:optionalstring

Field to sort by. Prefix with - for descending. Defaults to sort_order, the catalog's display order.

  • sort_order, -sort_order
  • name, -name
  • created_at, -created_at
  • id, -id

Only created_at and id work with cursor pagination. ?paginate=cursor with any other ordering, including the default, returns 400 ordering_not_cursor_eligible.

Pagination ​

per_page:optionalinteger

Page size. Defaults to 50, maximum 200. The catalog is small, so one page usually holds all of it.

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 (no COUNT query), which returns next_cursor and has_more instead of next and total_count. Requires order_by set to created_at, -created_at, id, or -id. Omit it for 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.

Requestable here: created_at, description, id, is_active, logo_props, name, slug, sort_order, updated_at, updated_by_id.

See Sparse fields.

Scopes ​

template_categories:read

Errors ​

StatusCodeCause
400invalid_request?fields= names an unknown field.
400ordering_not_cursor_eligible?paginate=cursor with an ordering other than created_at or id, including the default.
401unauthorizedMissing or invalid credentials.
402payment_requiredDeclared on every operation. The catalog has no feature gate, so this endpoint doesn't return it.
403forbiddenYour token scope can't read template categories.
404not_foundDeclared on every operation. The list has no path parameters to miss.
406not_acceptableThe Accept header asks for a representation the API can't produce.
429rate_limitedThrottled. Honor the Retry-After header before retrying.
List template categories
bash
curl -X GET \
  "https://api.plane.so/api/v2/template-categories/" \
  -H "X-Api-Key: $PLANE_API_KEY"
Response200
json
{
  "data": [
    {
      "id": "0c6e2a8f-4d1b-4e93-b7a5-9f3c1d8e2b60",
      "name": "Engineering",
      "slug": "engineering",
      "description": "Templates for software teams",
      "logo_props": {},
      "sort_order": 10000.0,
      "is_active": true,
      "created_at": "2025-11-04T08:15:27.640912Z",
      "updated_at": "2025-11-04T08:15:27.640912Z",
      "updated_by_id": null
    },
    {
      "id": "3a7f1d5b-8e24-4c69-b0d3-6e9a2c4f7b18",
      "name": "Marketing",
      "slug": "marketing",
      "description": "Templates for campaigns and launches",
      "logo_props": {},
      "sort_order": 20000.0,
      "is_active": true,
      "created_at": "2025-11-04T08:15:27.702455Z",
      "updated_at": "2025-11-04T08:15:27.702455Z",
      "updated_by_id": null
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 2,
  "pagination": {
    "style": "offset"
  }
}
Response200
json
{
  "data": [
    {
      "id": "9b4e7c2a-5f18-4d63-a2e9-0c7d3b8f1a56",
      "name": "Legacy",
      "slug": "legacy",
      "description": "Retired categories kept for older templates",
      "logo_props": {},
      "sort_order": 90000.0,
      "is_active": false,
      "created_at": "2025-11-04T08:15:27.811094Z",
      "updated_at": "2026-01-20T12:03:48.215667Z",
      "updated_by_id": null
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 1,
  "pagination": {
    "style": "offset"
  }
}