Milestones
Plan and track progress with milestones on boards.
Milestones group tickets around a goal or deadline. Each milestone tracks progress by aggregating the status of its assigned tickets. Milestones require the Milestones & Releases feature to be enabled on the board.
List Milestones
GET /api/v1/boards/{boardId}/milestonesPermission required: milestones:view
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| includeDeleted | boolean | No | Include soft-deleted milestones |
| sortBy | string | No | Sort field |
| sortOrder | string | No | asc or desc |
Example Response
[
{
"id": "ms_abc123",
"name": "v2.0 Launch",
"description": "Major platform release",
"dueDate": "2025-06-01T00:00:00Z",
"color": "#8B5CF6",
"progress": {
"total": 12,
"completed": 8,
"percentage": 67
},
"createdAt": "2025-01-15T10:00:00Z"
}
]Create Milestone
POST /api/v1/boards/{boardId}/milestonesPermission required: milestones:create
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Milestone name (max 200 characters, unique per board) |
| description | string | No | Milestone description |
| dueDate | string | Yes | Due date (ISO 8601) |
| color | string | No | Color in hex format (e.g. #8B5CF6) |
| sortOrder | number | No | Display order |
Example Request
{
"name": "v2.0 Launch",
"description": "Major platform release",
"dueDate": "2025-06-01T00:00:00Z",
"color": "#8B5CF6"
}Get Milestone
GET /api/v1/boards/{boardId}/milestones/{milestoneId}Permission required: milestones:view
Returns a milestone with progress information.
Update Milestone
PATCH /api/v1/boards/{boardId}/milestones/{milestoneId}Permission required: milestones:edit
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | No | Milestone name |
| description | string | No | Milestone description |
| dueDate | string | No | Due date (ISO 8601) |
| color | string | No | Color in hex format |
Delete Milestone
DELETE /api/v1/boards/{boardId}/milestones/{milestoneId}Permission required: milestones:delete
Soft-deletes the milestone. Returns 204 No Content.
Get Milestone Tickets
GET /api/v1/boards/{boardId}/milestones/{milestoneId}/ticketsPermission required: milestones:view
Returns all tickets assigned to a milestone.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| status | string | No | Filter by status category: PLANNING, ACTIVE, or FINAL |