Project milestones API

Tier: Free, Premium, Ultimate
Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

Use this API to manage project milestones.

For group milestones, use the group milestones API.

List all project milestones

Lists all milestones for a project.

GET /projects/:id/milestones
GET /projects/:id/milestones?iids[]=42
GET /projects/:id/milestones?iids[]=42&iids[]=43
GET /projects/:id/milestones?state=active
GET /projects/:id/milestones?state=closed
GET /projects/:id/milestones?title=1.0
GET /projects/:id/milestones?search=version
GET /projects/:id/milestones?search_title=17.3+17.4
GET /projects/:id/milestones?search_title=17.3%2017.4
GET /projects/:id/milestones?updated_before=2013-10-02T09%3A24%3A18Z
GET /projects/:id/milestones?updated_after=2013-10-02T09%3A24%3A18Z
GET /projects/:id/milestones?containing_date=2013-10-02T09%3A24%3A18Z
GET /projects/:id/milestones?start_date=2013-10-02T09%3A24%3A18Z&end_date=2013-11-02T09%3A24%3A18Z
GET /projects/:id/milestones?sort=due_date_desc

Parameters:

Attribute	Type	Required	Description
`id`	integer or string	yes	The ID or URL-encoded path of the project
`iids[]`	integer array	no	Return only the milestones having the given `iid`. Ignored if `include_ancestors` is `true`.
`state`	string	no	Return only `active` or `closed` milestones
`title`	string	no	Return only the milestones having the given `title`
`search`	string	no	Return only milestones with a title or description matching the provided string
`search_title`	string	no	Return only milestones with a title matching the provided string (case-insensitive). To search for multiple terms, separate them with an escaped space, either `+` or `%20`. Results must match all terms. For example, `17.4+17.5` matches the substrings `17.4` and `17.5` in any order.
`include_parent_milestones`	boolean	no	Deprecated. Use `include_ancestors` instead.
`include_ancestors`	boolean	no	Include milestones from all parent groups.
`updated_before`	datetime	no	Return only milestones updated before the given datetime. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`).
`updated_after`	datetime	no	Return only milestones updated after the given datetime. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`).
`containing_date`	datetime	no	Return only milestones where `start_date <= containing_date <= due_date`. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`).
`start_date`	datetime	no	Return only milestones where `due_date >=` the provided `start_date`. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`). Note: only valid if `end_date` is also provided.
`end_date`	datetime	no	Return only milestones where `start_date <=` the provided `end_date`. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`). Note: only valid if `start_date` is also provided.
`sort`	string	no	Return milestones sorted in the given order. Possible values: `due_date_asc`, `due_date_desc`, `start_date_asc`, `start_date_desc`, `name_asc`, `name_desc`, `created_asc`, `created_desc`, `updated_asc`, `updated_desc`. Default is `due_date_asc`.

shell
curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/milestones"

Example Response:

json
[
  {
    "id": 12,
    "iid": 3,
    "project_id": 16,
    "title": "10.0",
    "description": "Version",
    "due_date": "2013-11-29",
    "start_date": "2013-11-10",
    "state": "active",
    "updated_at": "2013-10-02T09:24:18Z",
    "created_at": "2013-10-02T09:24:18Z",
    "expired": false
  }
]

Retrieve a milestone

Retrieves a specified project milestone.

GET /projects/:id/milestones/:milestone_id

Parameters:

Attribute	Type	Required	Description
`id`	integer or string	yes	The ID or URL-encoded path of the project
`milestone_id`	integer	yes	The ID of the project’s milestone

Create a milestone

Creates a project milestone.

POST /projects/:id/milestones

Parameters:

Attribute	Type	Required	Description
`id`	integer or string	yes	The ID or URL-encoded path of the project
`title`	string	yes	The title of a milestone
`description`	string	no	The description of the milestone
`due_date`	string	no	The due date of the milestone (`YYYY-MM-DD`)
`start_date`	string	no	The start date of the milestone (`YYYY-MM-DD`)

Update a milestone

Updates a specified project milestone.

PUT /projects/:id/milestones/:milestone_id

Parameters:

Attribute	Type	Required	Description
`id`	integer or string	yes	The ID or URL-encoded path of the project
`milestone_id`	integer	yes	The ID of the project’s milestone
`title`	string	no	The title of a milestone
`description`	string	no	The description of the milestone
`due_date`	string	no	The due date of the milestone (`YYYY-MM-DD`)
`start_date`	string	no	The start date of the milestone (`YYYY-MM-DD`)
`state_event`	string	no	The state event of the milestone (close or activate)

Delete a milestone

Deletes a specified project milestone.

Only for users with the Planner, Reporter, Developer, Maintainer, or Owner role for the project.

DELETE /projects/:id/milestones/:milestone_id

Parameters:

Attribute	Type	Required	Description
`id`	integer or string	yes	The ID or URL-encoded path of the project
`milestone_id`	integer	yes	The ID of the project’s milestone

List all issues for a milestone

Lists all issues assigned to a specified project milestone.

GET /projects/:id/milestones/:milestone_id/issues

Parameters:

Attribute	Type	Required	Description
`id`	integer or string	yes	The ID or URL-encoded path of the project
`milestone_id`	integer	yes	The ID of the project’s milestone

List all merge requests for a milestone

Lists all merge requests assigned to a specified project milestone.

GET /projects/:id/milestones/:milestone_id/merge_requests

Parameters:

Attribute	Type	Required	Description
`id`	integer or string	yes	The ID or URL-encoded path of the project
`milestone_id`	integer	yes	The ID of the project’s milestone

Promote a milestone to group milestone

Promotes a project milestone to a group milestone.

Only for users with the Planner, Reporter, Developer, Maintainer, or Owner role for the group.

POST /projects/:id/milestones/:milestone_id/promote

Parameters:

Attribute	Type	Required	Description
`id`	integer or string	yes	The ID or URL-encoded path of the project
`milestone_id`	integer	yes	The ID of the project’s milestone

List all burndown chart events for a milestone

Tier: Premium, Ultimate
Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

Lists all burndown chart events for a specified milestone.

GET /projects/:id/milestones/:milestone_id/burndown_events

Parameters:

Attribute	Type	Required	Description
`id`	integer or string	yes	The ID or URL-encoded path of the project
`milestone_id`	integer	yes	The ID of the project’s milestone

Was this page helpful?