Workflow Templates

A workflow template defines an ordered list of stages (e.g. backlog → in_progress → review → done) that crews attach to their issue trackers. The frontend renders these as column headers on board views; the issue handler enforces the stage transitions when an issue moves between columns. Implementation: internal/api/workflow_templates_handler.go. Backed by the workflow_templates table (schema introduced in migration v19, see internal/database/migrate_consts_v16_v25.go).

All endpoints require an authenticated session and workspace context. Mutating verbs additionally require OWNER, ADMIN, or MANAGER role (requireRole("create")).

Endpoints

Method	Endpoint	Purpose
GET	`/api/v1/workflow-templates`	List templates
POST	`/api/v1/workflow-templates`	Create a template
GET	`/api/v1/workflow-templates/{id}`	Get a single template
PATCH	`/api/v1/workflow-templates/{id}`	Update a template
DELETE	`/api/v1/workflow-templates/{id}`	Delete a template

Template shape

Field	Type	Notes
`id`	string (CUID)
`name`	string	Workspace-unique. The DB has a `UNIQUE(workspace_id, name)` index — collisions on `POST`/`PATCH` surface as `409`.
`description`	string \| null
`template_json`	string	JSON-encoded stage array. See Stage shape. The server validates and re-marshals it on every write, so reads use canonical JSON formatting.
`icon`	string \| null	Optional icon value returned to the client.
`color`	string \| null	Optional template color. On update, a non-empty value must be a 3- or 6-digit hex string such as `#3B82F6`.
`is_builtin`	bool	Server-controlled. `true` for the seed-time templates; user-created rows are always `false`. Callers cannot mark their own rows as built-in.
`created_at`	RFC3339
`updated_at`	RFC3339

Stage shape

Stages live inside template_json as a JSON array. Each stage:

Field	Type	Required	Notes
`name`	string	Yes	Unique within the template (case-sensitive — the DB stores it verbatim).
`type`	string	Yes	One of `open`, `started`, `completed`, `cancelled`. Drives behaviour beyond display (e.g. closed-state inference).
`position`	integer	Yes	Positive integer; unique within the template; controls left-to-right order on board views. `0` and negative values reject as `400`.
`color`	string	No	Hex string like `#3B82F6` (3- or 6-digit). Empty/missing renders with the workspace default.

Validation rules enforced by validateTemplateJSON:

At least one stage.
Exactly one stage with type: open.
At least one stage with type: completed.
All name values unique; all position values unique.

Violations return 400 with a single-sentence message describing the failing constraint.

Endpoint reference

CRUD over templates. Built-in rows are server-controlled and surface first on List.

`GET /api/v1/workflow-templates`

List every template visible to the current workspace. Built-in rows surface first (is_builtin DESC), then user-created rows by created_at ASC. Request: No request body or query parameters. Auth: authenticated session + workspace context. Response: 200 OK — JSON array (never null).

[
  {
    "id": "wt_01HVZ...",
    "name": "Engineering Standard",
    "description": "Default engineering lifecycle",
    "template_json": "[{\"name\":\"backlog\",\"type\":\"open\",\"position\":1,\"color\":\"#9CA3AF\"},{\"name\":\"in_progress\",\"type\":\"started\",\"position\":2,\"color\":\"#3B82F6\"},{\"name\":\"done\",\"type\":\"completed\",\"position\":3,\"color\":\"#10B981\"}]",
    "icon": ":hammer_and_wrench:",
    "color": "#3B82F6",
    "is_builtin": false,
    "created_at": "2026-05-19T18:22:10Z",
    "updated_at": "2026-05-19T18:22:10Z"
  }
]

`POST /api/v1/workflow-templates`

Create a new user-owned template. Auth: authenticated session + workspace context + requireRole("create"). Request body:

Field	Type	Required	Notes
`name`	string	Yes	Workspace-unique.
`description`	string \| null	No
`template_json`	string	Yes	Stage array (see Stage shape). The handler validates and canonicalizes this value before storing it.
`icon`	string \| null	No
`color`	string \| null	No	Optional template color. The create handler stores this value without applying the update handler’s top-level hex validation.

Response: 201 Created with the full template object.

Status	Condition
`400`	Invalid JSON, missing `name`, missing/invalid `template_json` (any stage rule above).
`401`	Not authenticated.
`403`	Caller is below the `MANAGER` role.
`409`	A template with the same `name` already exists in this workspace.

Broadcasts workflow_template.created on the workspace WS channel with {"id": "<id>"}.

`GET /api/v1/workflow-templates/{id}`

Fetch a single template by id, scoped to the calling workspace. Request: No request body. The {id} path parameter identifies the workflow template. Auth: authenticated session + workspace context. Response: 200 OK with the template object.

Status	Condition
`404`	Template id does not exist, or exists in a different workspace. The handler deliberately collapses these into one response code so cross-workspace existence can’t be inferred.

`PATCH /api/v1/workflow-templates/{id}`

Partial update. Only the mutable subset (name, description, template_json, icon, color) is writable. is_builtin, created_at, and id are immutable; updated_at is set to “now” on every successful write. Auth: authenticated session + workspace context + requireRole("create"). Request body: every field optional; only provided (non-null) keys are written.

Field	Type	Notes
`name`	string	Empty string → `400 name cannot be empty`.
`description`	string	Empty string clears the column (stored as SQL `NULL`).
`template_json`	string	Re-validated against the full stage rule set on every write — there is no partial-stage edit path.
`icon`	string	Empty string clears to `NULL`.
`color`	string	Empty string clears to `NULL`; non-empty must match the hex regex.

Response: 200 OK with the freshly-updated template (so callers don’t need to re-GET).

Status	Condition
`400`	Malformed body, no fields supplied, or any stage rule violation.
`401`	Not authenticated.
`403`	Caller is below the `MANAGER` role.
`404`	Template id does not exist in this workspace.
`409`	New `name` collides with an existing template in the workspace.

Broadcasts workflow_template.updated on the workspace WS channel with {"id": "<id>"}.

`DELETE /api/v1/workflow-templates/{id}`

Hard delete. The template row is removed outright; the handler does not soft-delete it. Request: No request body. The {id} path parameter identifies the workflow template to delete.

Hard delete (no soft delete).

Auth: authenticated session + workspace context + requireRole("create"). Response: 204 No Content.

Status	Condition
`401`	Not authenticated.
`403`	Caller is below the `MANAGER` role.
`404`	Template id does not exist in this workspace.

Broadcasts workflow_template.deleted on the workspace WS channel with {"id": "<id>"}.

API

Workflow Templates

Workflow Templates

Endpoints

Template shape

Stage shape

Endpoint reference

`GET /api/v1/workflow-templates`

`POST /api/v1/workflow-templates`

`GET /api/v1/workflow-templates/{id}`

`PATCH /api/v1/workflow-templates/{id}`

`DELETE /api/v1/workflow-templates/{id}`

See also

​Workflow Templates

​Endpoints

​Template shape

​Stage shape

​Endpoint reference

​GET /api/v1/workflow-templates

​POST /api/v1/workflow-templates

​GET /api/v1/workflow-templates/{id}

​PATCH /api/v1/workflow-templates/{id}

​DELETE /api/v1/workflow-templates/{id}

​See also

Workflow Templates

Endpoints

Template shape

Stage shape

Endpoint reference

`GET /api/v1/workflow-templates`

`POST /api/v1/workflow-templates`

`GET /api/v1/workflow-templates/{id}`

`PATCH /api/v1/workflow-templates/{id}`

`DELETE /api/v1/workflow-templates/{id}`

See also