Value Streams

Manage value streams for organizing projects by business capability. Value streams represent high-level product or business areas (e.g. "Customer Growth", "Platform Reliability") that group related projects for portfolio-level reporting.

Value Stream Object

Field	Type	Description
id	string	Unique identifier (CUID format). System-generated. Read-only.
name	string	Value stream name (e.g. "Customer Growth").
description	string | null	Description of the business capability this stream covers.
isActive	boolean	Whether this value stream is active.
sortOrder	integer	Display ordering weight. Lower values appear first.
createdAt	datetime (ISO 8601)	When the record was created. Read-only.
updatedAt	datetime (ISO 8601)	When the record was last modified. Read-only.

---

Endpoints

Method	Path	Description
GET	/org/:orgId/value-streams	List value streams
GET	/org/:orgId/value-streams/:id	Get value stream
POST	/org/:orgId/value-streams	Create value stream
PATCH	/org/:orgId/value-streams/:id	Update value stream
DELETE	/org/:orgId/value-streams/:id	Delete value stream

---

List Value Streams

GET /org/:orgId/value-streams

Query Parameters

Parameter	Type	Default	Description
page	integer	1	Page number (1-based).
limit	integer	20	Records per page. Min 1, max 100.
search	string	--	Free-text search by name.
sortBy	string	name	Field to sort by: name, sortOrder, createdAt.
sortDir	string	asc	asc or desc.

Example Request

curl -X GET "https://{tenant}.flowstate.inc/api/v1/org/{orgId}/value-streams?sortBy=name" \
  -H "Authorization: Bearer private_..."

Example Response

{
  "data": [
    {
      "id": "clx6t7u8v9w0x1y2z3a4",
      "name": "Customer Growth",
      "description": "Initiatives focused on customer acquisition and retention",
      "isActive": true,
      "sortOrder": 0,
      "createdAt": "2024-01-10T08:00:00Z",
      "updatedAt": "2025-11-20T14:00:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 4,
    "hasNextPage": false
  }
}

---

Create Value Stream

POST /org/:orgId/value-streams

Create Request Body

Field	Type	Required	Description
name	string	Yes	Value stream name.
description	string | null	No	Description.
isActive	boolean	No	Default: true.
sortOrder	integer	No	Display ordering. Default: 0.

Update Request Body

All fields from Create are accepted, all optional.

Example Request

curl -X POST "https://{tenant}.flowstate.inc/api/v1/org/{orgId}/value-streams" \
  -H "Authorization: Bearer private_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Customer Growth",
    "description": "Initiatives focused on customer acquisition and retention"
  }'

Status: 201 Created

---

Error Responses

Validation Error (400)

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Request validation failed.",
    "details": [{ "field": "name", "message": "name is required" }],
    "errorId": "err_clx9a8b7c6d5e4f3"
  }
}

Not Found (404)

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Value stream not found.",
    "errorId": "err_clx9a8b7c6d5e4f3"
  }
}

---

Related Endpoints

• Projects -- Projects can belong to a value stream via valueStreamId.