Skip to content

Get a workspace work item type

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

Retrieve one workspace-level type by id. Reach for this when you already hold a type id — from a work item's type_id, a webhook payload, or a stored mapping — and need its current name, description, or active flag.

Reads work in either mode

Retrieval is unaffected by work item type modes. A workspace type stays readable here even when the workspace manages types at the project level; only writes are mode-gated.

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 id of the work item type to retrieve. A project-level type id returns 404 here — this endpoint only resolves types defined on the workspace.

Scopes

workspaces.work_item_types:read

Errors

StatusCodeCause
401unauthorizedMissing or invalid credentials.
403forbiddenYour role or token scope can't read this workspace's types.
404resource_not_foundNo such type or workspace, or it's outside your tenant.
429rate_limitedThrottled. Honor the Retry-After header before retrying.

No expansion, and no external ids

Work item types don't accept ?expand= — the response is the flat object shown here. external_id and external_source are write-only and never come back, so resolve a type by the Plane id you stored at create time.

Existence is never leaked

A type outside your tenant returns 404, not 403. If a cached id starts returning 404, re-read the workspace's set with List workspace work item types rather than retrying.

Get a workspace work item type
bash
curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/work-item-types/c1a7d3f4-6b28-4e90-8d15-2f7a0b9c4e63/" \
  -H "X-Api-Key: $PLANE_API_KEY"
Response200
json
{
  "id": "c1a7d3f4-6b28-4e90-8d15-2f7a0b9c4e63",
  "name": "Bug",
  "description": "Something is broken and needs a fix",
  "is_active": true,
  "is_default": false,
  "is_epic": false,
  "level": 0,
  "logo_props": {},
  "created_at": "2026-01-14T09:22:41.478363Z"
}
Response404
json
{
  "type": "https://api.plane.so/errors/resource-not-found",
  "title": "Not Found",
  "status": 404,
  "code": "resource_not_found",
  "detail": "No Issue Type matches the given query."
}