Workspaces

A workspace is a board: a named container with an ordered set of stages (columns). Tasks live inside exactly one workspace and one stage. The API exposes workspaces read-only — creating, renaming, or restructuring them is an in-app operation in v1.

Endpoints

Workspace model

{
  "id": "1f3c…",
  "organizationId": "0a1b…",
  "name": "Engineering",
  "stages": [
    { "id": "s1…", "name": "Pending", "sortOrder": 0, "isFinalizing": false },
    { "id": "s2…", "name": "Doing",   "sortOrder": 1, "isFinalizing": false },
    { "id": "s3…", "name": "Done",    "sortOrder": 2, "isFinalizing": true }
  ],
  "createdAt": "...",
  "updatedAt": "..."
}

Each org always has at least one workspace. By default, a new organization comes with one workspace called "Workspace" and three stages: Pending, Doing, Done (Done is the finalizing stage).

Stage semantics

• sortOrder — board columns are rendered left-to-right by ascending sortOrder.
• isFinalizing — at most one stage per workspace can be finalizing. Dropping a task into the finalizing stage auto-finalizes it; dragging out reopens it.

Listing workspaces

GET /api/v1/workspaces?limit=25&offset=0

Returns { data, total }. Each entry includes its ordered stages but no tasks — use the detail endpoint for that.

Fetching one workspace with tasks

GET /api/v1/workspaces/{id}

Response:

{
  "data": {
    "id": "...",
    "name": "Engineering",
    "stages": [...],
    "tasks": [...]
  }
}

Tasks include their assignees, tags, taskType, and project. The task list is filtered by the caller's project visibility — standard members may see a different task set than an admin viewing the same workspace.

What's not in the API

Workspace and stage mutations (create / rename / add stage / mark finalizing / reorder) are dashboard-only in v1. See the in-app workspace docs for the available controls.