List work item types

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

Return the work item types available in a project as a paginated list. This is how you resolve a type name such as Bug to the type_id you send when creating a work item, and how you build a type picker that stays in sync with the project's configuration.

Reading types is unaffected by work item type mode. A project in workspace mode still lists the types imported into it here, so a read integration never has to branch on 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.

project_id:requiredstring (uuid)

The project whose work item types you want to list.

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.

The API does not validate order_by or paginate, so check your spelling. An unrecognized order_by value falls back to the default ordering, and anything other than paginate=cursor uses offset pagination. A typo shows up as an unexpected sort order or envelope, not as an error.

Ordering

order_by:optionalstring

Field to sort by. Prefix with - for descending.

• level , -level: the type hierarchy level
• name , -name: alphabetical
• created_at , -created_at: when each type was added
• id , -id

Order by level when you are rendering types to a user; it is the order the project itself uses.

Pagination

per_page:optionalinteger

Page size. Defaults to 50, maximum 200. Most projects define a handful of 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. Use the next value from the response instead of computing offsets yourself.

paginate:optionalstring

Set to cursor to switch to the keyset envelope, which skips the COUNT query and returns next_cursor and has_more instead of next and total_count. Leave it out to get 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, 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

projects.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 project's work item types.
404	not_found	No such workspace or project, 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 work item types

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/work-item-types/?order_by=level&per_page=50" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

response = requests.get(
    "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/work-item-types/",
    headers={"X-Api-Key": "your-api-key"},
    params={"order_by": "level", "per_page": 50},
)
print(response.json())

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

Response200

{
  "data": [
    {
      "id": "9c2f8e51-4a63-47d8-b1e0-5f7a2c40d693",
      "name": "Task",
      "description": "Default work item type with the option to add new properties",
      "logo_props": {
        "in_use": "icon",
        "icon": {
          "name": "Check",
          "background_color": "#1FA191"
        }
      },
      "is_epic": false,
      "is_default": true,
      "is_active": true,
      "is_active_in_project": true,
      "is_default_in_project": true,
      "level": 0,
      "governance_mode": "any",
      "rollout": "none",
      "project_ids": ["4af68566-94a4-4eb3-94aa-50dc9427067b"],
      "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": "d1e7a4c9-2b58-4f36-9a0e-7c3b5d81f240",
      "name": "Bug",
      "description": "Something is broken and needs a fix",
      "logo_props": {
        "in_use": "icon",
        "icon": {
          "name": "AlertCircle",
          "background_color": "#EF5974"
        }
      },
      "is_epic": false,
      "is_default": false,
      "is_active": true,
      "is_active_in_project": true,
      "is_default_in_project": false,
      "level": 0,
      "governance_mode": "any",
      "rollout": "none",
      "project_ids": ["4af68566-94a4-4eb3-94aa-50dc9427067b"],
      "external_id": null,
      "external_source": null,
      "created_at": "2026-01-14T09:24:03.117482Z",
      "updated_at": "2026-01-14T09:24:03.117482Z",
      "updated_by_id": null
    }
  ],
  "next": null,
  "previous": null,
  "total_count": 2,
  "pagination": {
    "style": "offset"
  }
}

Response200

{
  "data": [
    {
      "id": "9c2f8e51-4a63-47d8-b1e0-5f7a2c40d693",
      "name": "Task",
      "description": "Default work item type with the option to add new properties",
      "logo_props": {
        "in_use": "icon",
        "icon": {
          "name": "Check",
          "background_color": "#1FA191"
        }
      },
      "is_epic": false,
      "is_default": true,
      "is_active": true,
      "is_active_in_project": true,
      "is_default_in_project": true,
      "level": 0,
      "governance_mode": "any",
      "rollout": "none",
      "project_ids": ["4af68566-94a4-4eb3-94aa-50dc9427067b"],
      "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"
  }
}

An empty list is a real answer

A project that has never called enable returns an empty data array rather than an error. Treat "no types" as "the feature has not been turned on for this project yet", not as a failure.

Listing does not tell you what a type accepts

The list gives you names and ids. To find out which fields and custom properties a work item of a given type takes, call Get a work item type schema with that type's id.