Value Streams

Manage value streams for organizing projects by business capability.

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

Returns a paginated list of value streams in the organization.

Query Parameters

Parameter	Type	Default	Description
page	integer	1	Page number
limit	integer	20	Records per page (max 200)
search	string	—	Search by name
sortBy	string	name	Sort field: 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&limit=50" \
  -H "Authorization: Bearer private_..."

Example Response

{
  "data": [
    {
      "id": "clx6t7u8v9w0x1y2",
      "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"
    },
    {
      "id": "clx1e2n3g4r5o0t6",
      "name": "Platform Reliability",
      "description": "Infrastructure stability and uptime improvements",
      "isActive": true,
      "sortOrder": 1,
      "createdAt": "2024-01-05T08:00:00Z",
      "updatedAt": "2025-09-01T10:00:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 50,
    "total": 4,
    "hasNextPage": false
  }
}

---

Get Value Stream

GET /org/:orgId/value-streams/:id

Returns a single value stream by ID.

Example Request

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

Example Response

{
  "data": {
    "id": "clx6t7u8v9w0x1y2",
    "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"
  }
}

---

Create Value Stream

POST /org/:orgId/value-streams

Creates a new value stream.

Request Body

{
  "name": "Customer Growth",
  "description": "Initiatives focused on customer acquisition and retention"
}

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"
  }'

Example Response

{
  "data": {
    "id": "clx3d4e5f6g7h8i9",
    "name": "Customer Growth",
    "description": "Initiatives focused on customer acquisition and retention",
    "isActive": true,
    "sortOrder": 0,
    "createdAt": "2026-03-11T09:40:00Z",
    "updatedAt": "2026-03-11T09:40:00Z"
  }
}

Status: 201 Created

---

Update Value Stream

PATCH /org/:orgId/value-streams/:id

Updates one or more fields on an existing value stream. Only include the fields you want to change.

Example Request

curl -X PATCH "https://{tenant}.flowstate.inc/api/v1/org/{orgId}/value-streams/clx6t7u8v9w0x1y2" \
  -H "Authorization: Bearer private_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Customer Growth & Retention",
    "description": "All initiatives driving customer acquisition, engagement, and retention."
  }'

Example Response

{
  "data": {
    "id": "clx6t7u8v9w0x1y2",
    "name": "Customer Growth & Retention",
    "description": "All initiatives driving customer acquisition, engagement, and retention.",
    "isActive": true,
    "sortOrder": 0,
    "createdAt": "2024-01-10T08:00:00Z",
    "updatedAt": "2026-03-11T09:45:00Z"
  }
}

---

Delete Value Stream

DELETE /org/:orgId/value-streams/:id

Deletes a value stream. Value streams that are actively assigned to projects cannot be deleted until those references are removed.

Example Request

curl -X DELETE "https://{tenant}.flowstate.inc/api/v1/org/{orgId}/value-streams/clx6t7u8v9w0x1y2" \
  -H "Authorization: Bearer private_..."

Example Response

{
  "data": {
    "id": "clx6t7u8v9w0x1y2",
    "deleted": true
  }
}

Status: 200 OK

---

Field Reference

Field	Type	Required	Description
id	string	—	Unique identifier (read-only)
name	string	Yes	Value stream name
description	string	No	Value stream description
isActive	boolean	No	Whether the value stream is active (default: true)
sortOrder	integer	No	Display sort order (default: 0)
createdAt	datetime	—	Record creation timestamp (read-only)
updatedAt	datetime	—	Last modification timestamp (read-only)