Create a work item type

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

Add a work item type, such as Bug, Spike, or Chore, to a project. The new type is immediately selectable on work items, and you can attach custom properties to it.

Call Enable work item types first. Creating a type in a project where the feature has never been turned on leaves you with a type nobody can pick.

Keep the id from the response. Every later step uses it: attaching properties, reading the schema, and creating a work item of this type.

This write requires project mode

If the workspace manages types at the workspace level, this returns 409 work_item_types_managed_at_workspace. Create the type with the workspace endpoint instead, then import it into the project. See Work item type modes.

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 to add the type to.

Body parameters

name:requiredstring

Display name for the type, for example Bug. Maximum 255 characters.

description:optionalstring

What this type is for. The schema endpoint returns it as type_description, and an integration or agent uses it to decide between Bug and Task without a human in the loop.

is_active:optionalboolean

Whether the type can be assigned to new work items. Create it inactive if you are staging a configuration and want to attach its properties before anyone can select it.

external_id:optionalstring

Your system's identifier for this type, for sync and import correlation. Maximum 255 characters, nullable.

external_source:optionalstring

The system external_id came from, for example github or jira. Maximum 255 characters, nullable.

is_default, is_epic, level and logo_props are not accepted here

is_default moves through mark-default. is_epic and level are read-only. Plane generates logo_props when the type is created, and the response shows the value it picked.

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

projects.work_item_types:write

Errors

Status	Code	Cause
400	invalid_request	Missing name, or a field over its 255-character limit.
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 create 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.
409	conflict	A type in this project already uses this external_id and external_source pair.
413	payload_too_large	The request body is over the size limit.
415	unsupported_media_type	The Content-Type isn't one this endpoint accepts.
429	rate_limited	Throttled. Honor the Retry-After header before retrying.

Create a work item type

curl -X POST \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/work-item-types/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Bug",
  "description": "Something is broken and needs a fix",
  "is_active": true
}'

import requests

response = requests.post(
    "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"},
    json={
        "name": "Bug",
        "description": "Something is broken and needs a fix",
        "is_active": True,
    },
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/work-item-types/",
  {
    method: "POST",
    headers: {
      "X-Api-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      name: "Bug",
      description: "Something is broken and needs a fix",
      is_active: true,
    }),
  },
);
const data = await response.json();

Response201

{
  "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
}

Response409

{
  "type": "conflict",
  "code": "work_item_types_managed_at_workspace",
  "detail": "Work item types are managed at the workspace level for this workspace."
}

Reuse external_id to stay idempotent

external_id alone is not unique. Within a project, the pair (external_id, external_source) is. Send both when you sync from another system, so a repeated import returns 409 conflict instead of creating a duplicate type.