Milestones

The milestones endpoint allows you to retrieve all milestones associated with a project. Milestones help organize and track test runs across different versions or phases of your project.

List Project Milestones

GET/api/public/v0/project/{project_id}/milestone

Returns a list of all milestones in the project. This endpoint is particularly useful when you need milestone IDs for creating or cloning test runs.

Path Parameters

• project_id: The project identifier (can be either the project code or UUID)

Authentication

Requires an API key with at least Viewer role permissions. See Authentication for more details.

Response

Status: 200 OK

{
 milestones: Array<{
   id: number          // Unique identifier for the milestone
   title: string       // Name of the milestone
   description: string // Detailed description of the milestone
   createdAt: string   // ISO 8601 timestamp
   updatedAt: string   // ISO 8601 timestamp
 }>
}

Response Fields

Field	Type	Description
id	number	Unique identifier for the milestone
title	string	Name of the milestone
description	string	Detailed description of the milestone
createdAt	string	Creation timestamp in ISO 8601 format
updatedAt	string	Last update timestamp in ISO 8601 format

Example Request

curl \
  -H "Authorization: ApiKey your.api.key.here" \
  https://your-company.your-region-code.qasphere.com/api/public/v0/project/BD/milestone

Example Response

{
 "milestones": [
   {
     "id": 1,
     "title": "Version 0.9",
     "description": "Version 0.9",
     "createdAt": "2024-03-28T14:53:18.382368+05:30",
     "updatedAt": "2024-03-28T14:53:18.382368+05:30"
   },
   {
     "id": 2,
     "title": "Version 1.0",
     "description": "This is a long description for the first public release. It contains a lot of information about the release.",
     "createdAt": "2024-03-28T14:53:18.383228+05:30",
     "updatedAt": "2024-03-28T14:53:18.383228+05:30"
   }
 ]
}

Error Responses

Status Code	Description
401	Invalid or missing API key
403	Insufficient permissions or suspended tenant
404	Project not found
500	Internal server error during milestone listing

tip

Milestone IDs are used when creating test runs to associate them with specific project versions or phases. Make sure to store these IDs if you plan to create runs programmatically.

Validation

The system validates that the milestone belongs to the specified project. Attempting to use a milestone ID from a different project will result in an error.