List workspace work item types

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

Return the workspace's work item types as a paginated list. This is where you resolve a type name such as Bug to the id you need — to set type_id on a work item, to attach properties to the type, or to hand to a project import.

There is no project segment in the path: these are the types defined once for the whole workspace.

Reads work in either mode

Listing is unaffected by work item type modes. You can read the workspace list even while 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.

Query Parameters

Filters combine with AND.

name:optionalstring

Return the type with this name, compared case-insensitively. ?name=bug matches Bug.

external_id:optionalstring

Return types whose external_id matches exactly. Use it to find the type you created earlier for a record in another system.

external_source:optionalstring

Return types from one source system, for example jira. Combine it with external_id, because an external_id is unique only within its source.

Ordering

order_by:optionalstring

Field to sort by. Prefix with - for descending.

• name , -name — alphabetical, which is what you usually want for a picker
• level , -level — the type's level in the work item hierarchy
• created_at , -created_at — when each type was added
• id , -id

A value outside this list is not rejected — it quietly falls back to the default ordering. Check your spelling: a typo surfaces as a differently-sorted page, not as an error.

Pagination

per_page:optionalinteger

Page size. Defaults to 50, maximum 200. Most workspaces define fewer than 20 types, so one page is usually the whole set.

offset:optionalinteger

Number of rows to skip from the start of the result set. Maximum 10000. Read the next value from the response rather than computing offsets yourself.

paginate:optionalstring

Set to cursor to opt into the COUNT-free keyset envelope, which returns next_cursor and has_more instead of next and total_count. 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. 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, 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

Status	Code	Cause
401	unauthorized	Missing or invalid credentials.
402	payment_required	The feature this endpoint belongs to isn't enabled on your plan, or is switched off.
403	forbidden	Your role or token scope can't read this workspace's types.
404	not_found	No such workspace, or it's outside your tenant.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
429	rate_limited	Throttled. Honor the Retry-After header before retrying.

List workspace work item types

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/work-item-types/?order_by=name&per_page=50" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

response = requests.get(
    "https://api.plane.so/api/v2/workspaces/my-team/work-item-types/",
    headers={"X-Api-Key": "your-api-key"},
    params={"order_by": "name", "per_page": 50},
)
print(response.json())

const params = new URLSearchParams({ order_by: "name", per_page: "50" });
const response = await fetch(
  `https://api.plane.so/api/v2/workspaces/my-team/work-item-types/?${params}`,
  {
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

{
  "data": [
    {
      "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
    },
    {
      "id": "5e8b0c19-7a4d-42f6-9b83-1c0d6e2f7a45",
      "name": "Epic",
      "description": "A large body of work spanning several work items",
      "logo_props": {},
      "is_epic": true,
      "is_default": false,
      "is_active": true,
      "level": 1,
      "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.512907Z",
      "updated_at": "2026-01-14T09:22:41.512907Z",
      "updated_by_id": null
    },
    {
      "id": "9d2f1b73-4c85-4a06-b3e1-7f8c25a0d914",
      "name": "Task",
      "description": "Standard unit of work",
      "logo_props": {},
      "is_epic": false,
      "is_default": true,
      "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.548221Z",
      "updated_at": "2026-01-14T09:22:41.548221Z",
      "updated_by_id": null
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 3,
  "pagination": {
    "style": "offset"
  }
}

Response200

{
  "data": [
    {
      "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
    }
  ],
  "next_cursor": "b3A9MTcx",
  "has_more": true,
  "pagination": {
    "style": "cursor"
  }
}

Inactive types still list

is_active: false retires a type from pickers, but it keeps appearing in this list. Filter on is_active in your own code before you show the list to a user, and keep inactive types resolvable so historic work items still render with a name.