Project workspace

list-workflow-statuses-tool

List the workflow statuses available on a project, in workflow order, including allowed transitions.

Returns the statuses for the project's workflow plus, for each status, the list of status IDs it can transition to. Use this before calling update-work-item-tool (to pick a valid workflow_status_id on create) or before calling transition-work-item-status-tool (to know which transitions are allowed from the current status).

Inputs

NameTypeRequiredDescription
project_idintegeryesProject whose workflow statuses to list.

Permissions

  • project_management::view_backlog.

Example

{
  "project_id": 3
}

Response

{
  "data": [
    { "id": 11, "name": "To do", "color": "#9ca3af", "is_resolution": false, "order": 1, "allowed_transitions_to": [12] },
    { "id": 12, "name": "In progress", "color": "#fbbf24", "is_resolution": false, "order": 2, "allowed_transitions_to": [13, 11] },
    { "id": 13, "name": "Done", "color": "#22c55e", "is_resolution": true, "order": 3, "allowed_transitions_to": [] }
  ],
  "project": { "id": 3, "title": "ACME website", "workflow_id": 2 }
}

When the project has no workflow configured, data is an empty array.

Errors

  • An unknown project_id returns a validation error.
  • A caller without project_management::view_backlog receives an authorization error.

On this page