Board Statuses
View and configure which workflow statuses are active on a board.
Each board has its own status configuration built on top of the organization's global statuses. You can show, hide, or customize statuses per board to match each project's workflow.
List Board Statuses
GET /api/v1/boards/{boardId}/statusesQuery Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| category | string | No | Filter by category: PLANNING, ACTIVE, or FINAL |
| includeHidden | boolean | No | Include hidden statuses (default: false) |
Example Response
{
"data": [
{
"id": "sts_abc123",
"name": "Backlog",
"color": "#6B7280",
"category": "PLANNING",
"order": 0,
"isHidden": false,
"isDefault": true
},
{
"id": "sts_def456",
"name": "In Progress",
"color": "#3B82F6",
"category": "ACTIVE",
"order": 2,
"isHidden": false,
"isDefault": false
}
]
}Update Board Status Configuration
PATCH /api/v1/boards/{boardId}/statuses/{statusId}Permission required: settings:manage-statuses
Customize how a global status appears on this board (for example, hiding it or changing its display order).
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| isHidden | boolean | No | Whether to hide this status on the board |
| order | number | No | Display order position |
Reset Board Status Configuration
DELETE /api/v1/boards/{boardId}/statuses/{statusId}Permission required: settings:manage-statuses
Reset a board-level status override back to the organization defaults. Returns 204 No Content.