Skip to content

Get a template category ​

GET/api/v2/template-categories/{pk}/

Retrieve one template category by id. Use it to resolve an id from a project template's category_ids to a name and slug.

The catalog is global, so the path has no workspace. An inactive category returns 404 unless the request includes ?is_active=false, the same filter that List template categories uses.

Path Parameters ​

pk:requiredstring (uuid)

The id of the template category 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, 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.
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_foundNo category with this id, or the category is inactive and the request has no ?is_active=false.
406not_acceptableThe Accept header asks for a representation the API can't produce.
429rate_limitedThrottled. Honor the Retry-After header before retrying.
Get a template category
bash
curl -X GET \
  "https://api.plane.so/api/v2/template-categories/0c6e2a8f-4d1b-4e93-b7a5-9f3c1d8e2b60/" \
  -H "X-Api-Key: $PLANE_API_KEY"
Response200
json
{
  "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
}
Response404
json
{
  "type": "not_found",
  "code": "not_found",
  "detail": "The requested resource was not found."
}