Spedy Docs

Releases represent a versioned shipment of your product. Each release can include milestones and individual tickets. Releases require the Milestones & Releases feature to be enabled on the board.

List Releases

GET /api/v1/boards/{boardId}/releases

Permission required: releases:view

Example Response

[
  {
    "id": "rel_abc123",
    "name": "v2.0",
    "version": "2.0.0",
    "description": "Major platform release",
    "releaseDate": "2025-06-15T00:00:00Z",
    "milestones": [
      {
        "id": "ms_abc123",
        "name": "v2.0 Launch"
      }
    ],
    "ticketCount": 24,
    "createdAt": "2025-01-15T10:00:00Z"
  }
]

Create Release

POST /api/v1/boards/{boardId}/releases

Permission required: releases:create

Request Body

Field	Type	Required	Description
name	string	Yes	Release name (max 200 characters)
version	string	No	Version identifier, e.g. `2.0.0` (max 50 characters)
description	string	No	Release description
releaseDate	string	No	Target release date (ISO 8601)
milestoneIds	string[]	No	Milestone IDs to include

Example Request

{
  "name": "v2.0",
  "version": "2.0.0",
  "description": "Major platform release",
  "releaseDate": "2025-06-15T00:00:00Z",
  "milestoneIds": ["ms_abc123"]
}

Get Release

GET /api/v1/boards/{boardId}/releases/{releaseId}

Permission required: releases:view

Update Release

PATCH /api/v1/boards/{boardId}/releases/{releaseId}

Permission required: releases:edit

Request Body

Field	Type	Required	Description
name	string	No	Release name
version	string	No	Version identifier
description	string	No	Release description
releaseDate	string	No	Target release date

Delete Release

DELETE /api/v1/boards/{boardId}/releases/{releaseId}

Permission required: releases:delete

Returns 204 No Content.

Add Milestone to Release

POST /api/v1/boards/{boardId}/releases/{releaseId}/milestones

Permission required: releases:edit

Request Body

Field	Type	Required	Description
milestoneId	string	Yes	Milestone ID to add

Remove Milestone from Release

DELETE /api/v1/boards/{boardId}/releases/{releaseId}/milestones/{milestoneId}

Permission required: releases:edit

Add Ticket to Release

POST /api/v1/boards/{boardId}/releases/{releaseId}/tickets

Permission required: releases:edit

Request Body

Field	Type	Required	Description
ticketId	string	Yes	Ticket ID to add

Remove Ticket from Release

DELETE /api/v1/boards/{boardId}/releases/{releaseId}/tickets/{ticketId}

Permission required: releases:edit

Releases

On this page