Overview

Work items are the basic unit of work in Plane. Each one is a task in your project that you can assign, track, and complete.

Learn more about work items

The work item object

Attributes

• name string (required)

  Name of the work item

• created_at, updated_at timestamp

  When the work item was created and when it was last updated

• estimate_point integer or null

  Total estimate points for the work item. Takes a value between 0 and 7.

• description_html string

  HTML description of the work item

• description_stripped string

  The description as plain text, with HTML removed. Plane generates it automatically.

• priority string

  Priority of the work item. One of:

  • none
  • urgent
  • high
  • medium
  • low

• start_date date

  Start date of the work item

• target_date date

  Target date of the work item

• sequence_id integer

  Unique identifier of the work item. Plane generates it.

• sort_order decimal

  Position used for ordering. Plane generates it when the work item is created.

• completed_at timestamp or null

  When the work item moved to a state in the completed group

• created_by & updated_by

  IDs of the users who created and last updated the work item. Set automatically.

• project uuid

  ID of the project the work item belongs to. Set automatically.

• workspace uuid

  ID of the workspace the work item belongs to. Set automatically.

• parent uuid

  ID of the parent work item. It should be in the same workspace.

• state uuid

  ID of a state in the work item's project.

• assignees [uuid,]

  IDs of the assigned users, who are members of the work item's project.

• labels [uuid,]

  IDs of the labels applied to the work item, from the work item's project.

• type uuid

  ID of the work item's type.

• module uuid

  ID of the module the work item belongs to.

• is_draft boolean

  Whether the work item is a draft.

• archived_at timestamp or null

  Timestamp when the work item was archived.

• description_binary string

  Binary description of the work item.

Expandable fields

To expand these fields when you retrieve a work item, list them in the expand query parameter:

• type - Expands to full WorkItemType object
• module - Expands to full Module object
• labels - Expands to array of full Label objects
• assignees - Expands to array of full User objects
• state - Expands to full State object
• project - Expands to full Project object

Response200

{
  "id": "e1c25c66-5bb8-465e-a818-92a483423443",
  "created_at": "2023-11-19T11:56:55.176802Z",
  "updated_at": "2023-11-19T11:56:55.176809Z",
  "estimate_point": null,
  "name": "First Work Item",
  "description_html": "<p></p>",
  "description_stripped": "",
  "priority": "none",
  "start_date": "2023-09-01",
  "target_date": "2023-10-04",
  "sequence_id": 421,
  "sort_order": 265535.0,
  "completed_at": null,
  "archived_at": null,
  "is_draft": false,
  "created_by": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "updated_by": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "project": "4af68566-94a4-4eb3-94aa-50dc9427067b",
  "workspace": "cd4ab5a2-1a5f-4516-a6c6-8da1a9fa5be4",
  "parent": null,
  "state": "f3f045db-7e74-49f2-b3b2-0b7dee4635ae",
  "assignees": ["797b5aea-3f40-4199-be84-5f94e0d04501"],
  "labels": []
}