improvements

listImprovements

List AND grep improvements in a project. query searches the title, friendlyId and problem statement, not just the title (substring by default; set isRegex:true for a regular expression, caseSensitive:true for exact case). Supports filtering by status, type, priority, and by parentItemId for an item's children in the work hierarchy (an epic's stories, say). For ranked semantic + text search use searchImprovements. Every item carries its versionTimestamp, ready for updateImprovement, so one call here supplies the tokens for a whole batch of updates (fields ["id", "friendlyId", "versionTimestamp"] returns just those), and its parentItem: the item it belongs to in the work hierarchy ({ id, friendlyId, title, type, status, isTask }, or null).

post/tools/listImprovements

Request

  • Base URL: https://api.stablebaseline.io/functions/v1/cloud-serve/api/v1
  • URL: https://api.stablebaseline.io/functions/v1/cloud-serve/api/v1/tools/listImprovements
  • Auth: HTTP bearer

Request body

projectIdstring required
parentItemIdstring

Only the children of this item in the work hierarchy (its UUID or friendly id, such as IMP-12), whatever plan or phase they are in. "none" lists only the items with no parent. The work hierarchy is not the plan outline nesting (setPlanItemParent).

statusstring

Filter: captured, triaging, shaped, approved, ready_for_agent, in_progress, ready_for_review, in_review, blocked, done, rejected, deferred.

typestring

Filter by type: feature, enhancement, bug, tech_debt, architecture_gap, documentation_gap, risk, epic, user_story, requirement, test_case, spike, task. Tasks (is_task=true) always have type='task'.

prioritystring

Filter: low, medium, high, critical.

sourcestring

Filter by source: human_manual, agent_review, doc_comment, feedback, incident, postmortem, code_review, imported. agent_review is the Compliance view; 'other' is every source except agent_review (the General view).

categoryIdstring

Filter by category ID.

agentReadyboolean

Filter by agent readiness.

complianceOnlyboolean

Only compliance-linked improvements.

scanRunIdstring

Filter by compliance scan run.

frameworkKeystring

Filter by framework (e.g. soc2, iso27001).

querystring

Grep across title, friendlyId and problem_statement. Substring by default; a regular expression when isRegex:true; case-insensitive unless caseSensitive:true.

isRegexboolean

Treat query as a regular expression (grep -E), e.g. "ACME-\d+". Default false (literal substring).

caseSensitiveboolean

Case-sensitive matching. Default false.

sortFieldstring

Sort field. Default: position.

sortAscendingboolean

Sort ascending. Default: true.

limitnumber

Max results (1-100, default 50).

offsetnumber

Pagination offset.

fieldsstring[]

Field projection. Valid fields: id, friendly_id, friendlyId, title, type, status, priority, source, category_id, categoryId, parent_item_id, parentItemId, parentItem, created_at, createdAt, updated_at, updatedAt, versionTimestamp, href.

Response

Tool result (shape varies per tool — refer to the tool's docs for the exact return value).

object required

Changes

No recorded changes to this operation across all 1 revision of this API.