WorkflowStatus

One status in a workflow: the column a work item sits in, with the colour the badge is drawn in and whether reaching it resolves the item.

View as Markdown

Summary view: WorkflowStatusList, 10 fields. What a list returns by default.
Detail view: WorkflowStatus, 10 fields. The default for a single read and for every write.
Read with: api:read:workflowsandworkflows::read
Write with: api:write:workflowsandworkflows::create

Example

detail view

{
  "id": 1,
  "workflow_id": 4,
  "name": "Done",
  "color": "#22c55e",
  "is_resolution": true,
  "order": 1,
  "created_at": "2026-03-04T09:15:00Z",
  "updated_at": "2026-03-04T09:15:00Z",
  "workflow": {
    "id": 1
  },
  "links": {
    "self": "https://<your-url>/api/v2/work-items/1"
  }
}

Statuses belong to exactly one workflow and cannot be moved between workflows. Which statuses a work item may move to is a separate collection: the workflow transitions.

Used by

GETList workflow statuses/workflow-statusesWorkflowStatusList

POSTCreate a workflow status/workflow-statusesWorkflowStatus

GETRead a workflow status/workflow-statuses/{workflow_status}WorkflowStatus

PATCHUpdate a workflow status/workflow-statuses/{workflow_status}WorkflowStatus

Fields

Detail only: Only in the detail view.
Only with include: Only when you ask for it with include.
Server-assigned: Set by plnnrly, never by a request.

idinteger

Unique identifier.

workflow_idinteger

Workflow this status belongs to. A status cannot be moved to another workflow: its transitions and the work items sitting in it belong to this one.

namestring≤ 255

Status name as shown on the board column and the status badge, e.g. To do.

colorstring≤ 255

Six-digit hex colour, e.g. #6b7280. A stored value that is not six-digit hex reads back as #6b7280, so writing this field back unchanged replaces the malformed original.

is_resolutionboolean

Whether a work item reaching this status counts as resolved. Drives the backlog's done state and what a completed sprint carries over.

orderintegerServer-assigned

Position within the workflow, left to right on the board; set by dragging in plnnrly and not writable. API-created statuses are created at 0 and fall back to the id tiebreaker.

created_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Creation timestamp.

updated_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Last-write timestamp; use for incremental sync.

workflowRef or WorkflowSummary

Workflow this status belongs to.

linksWorkflowStatusLinks

Show 1 child field

links.selfurl

The canonical URI of this record.

Variants

WorkflowStatusList 10 fields

What a collection returns, and what ?view=summary returns on a single record.

The same fields as the detail object.

WorkflowStatusSummary 4 fields

The embedded form: what you get when another resource carries this one and you did not include it.

Leaves out: workflow_id, order, created_at, updated_at, workflow, links

WorkflowStatusLinks 1 field

The links object on this resource.

Keys: self

Something wrong or missing on this page? Tell us