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. Use it when you already have a type id, for example 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 depend on the mode.

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, because this endpoint only resolves types defined on the workspace.

Response shaping ​

fields:optionalstring

Comma-separated list of fields to return. 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, external_id, external_source, governance_mode, id, is_active, is_active_in_project, is_default, is_default_in_project, is_epic, level, logo_props, name, project_ids, rollout, updated_at, updated_by_id.

See Sparse fields.

Scopes ​

workspaces.work_item_types:read

Errors ​

StatusCodeCause
401unauthorizedMissing or invalid credentials.
402payment_requiredThe feature this endpoint belongs to isn't enabled on your plan, or is switched off.
403forbiddenYour role or token scope can't read this workspace's types.
404not_foundNo such type or workspace, 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.

No expansion, and no external ids

Work item types don't accept ?expand=, so the response is the flat object shown here. To find a type you synced from another system, filter List workspace work item types by external_id and external_source.

Records outside your tenant return 404

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",
  "logo_props": {},
  "is_epic": false,
  "is_default": false,
  "is_active": true,
  "level": 0,
  "governance_mode": "any",
  "rollout": "none",
  "project_ids": ["4af68566-94a4-4eb3-94aa-50dc9427067b", "7c19e5b3-2d84-4f6a-b0e7-93a1c5d8f246"],
  "external_id": null,
  "external_source": null,
  "created_at": "2026-01-14T09:22:41.478363Z",
  "updated_at": "2026-01-14T09:22:41.478363Z",
  "updated_by_id": null
}
Response404
json
{
  "type": "not_found",
  "code": "not_found",
  "detail": "No Issue Type matches the given query."
}