Group milestones API

Introduced in GitLab 9.5.

This page describes the group milestones API. There's a separate project milestones API page.

List group milestones

Returns a list of group milestones.

GET /groups/:id/milestones
GET /groups/:id/milestones?iids[]=42
GET /groups/:id/milestones?iids[]=42&iids[]=43
GET /groups/:id/milestones?state=active
GET /groups/:id/milestones?state=closed
GET /groups/:id/milestones?title=1.0
GET /groups/:id/milestones?search=version

Parameters:

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID or URL-encoded path of the group owned by the authenticated user
`iids[]`	integer array	no	Return only the milestones having the given `iid` (Note: ignored if `include_parent_milestones` is set as `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
`include_parent_milestones`	boolean	optional	Include milestones from parent group and its ancestors. Introduced in GitLab 13.4

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/milestones"

Example Response:

[
  {
    "id": 12,
    "iid": 3,
    "group_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,
    "web_url": "https://gitlab.com/groups/gitlab-org/-/milestones/42"
  }
]

Get single milestone

Gets a single group milestone.

GET /groups/:id/milestones/:milestone_id

Parameters:

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID or URL-encoded path of the group owned by the authenticated user
`milestone_id`	integer	yes	The ID of the group milestone

Create new milestone

Creates a new group milestone.

POST /groups/:id/milestones

Parameters:

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID or URL-encoded path of the group owned by the authenticated user
`title`	string	yes	The title of a milestone
`description`	string	no	The description of the milestone
`due_date`	date	no	The due date of the milestone, in YYYY-MM-DD format (ISO 8601)
`start_date`	date	no	The start date of the milestone, in YYYY-MM-DD format (ISO 8601)

Edit milestone

Updates an existing group milestone.

PUT /groups/:id/milestones/:milestone_id

Parameters:

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID or URL-encoded path of the group owned by the authenticated user
`milestone_id`	integer	yes	The ID of a group milestone
`title`	string	no	The title of a milestone
`description`	string	no	The description of a milestone
`due_date`	date	no	The due date of the milestone, in YYYY-MM-DD format (ISO 8601)
`start_date`	date	no	The start date of the milestone, in YYYY-MM-DD format (ISO 8601)
`state_event`	string	no	The state event of the milestone (`close` or `activate`)

Delete group milestone

Only for users with Developer access to the group.

DELETE /groups/:id/milestones/:milestone_id

Parameters:

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID or URL-encoded path of the group owned by the authenticated user
`milestone_id`	integer	yes	The ID of the group's milestone

Get all issues assigned to a single milestone

Gets all issues assigned to a single group milestone.

GET /groups/:id/milestones/:milestone_id/issues

Parameters:

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID or URL-encoded path of the group owned by the authenticated user
`milestone_id`	integer	yes	The ID of a group milestone

Get all merge requests assigned to a single milestone

Gets all merge requests assigned to a single group milestone.

GET /groups/:id/milestones/:milestone_id/merge_requests

Parameters:

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID or URL-encoded path of the group owned by the authenticated user
`milestone_id`	integer	yes	The ID of a group milestone

Get all burndown chart events for a single milestone (PREMIUM)

Introduced in GitLab 12.1

Moved to GitLab Premium in 13.9.

Get all burndown chart events for a single milestone.

GET /groups/:id/milestones/:milestone_id/burndown_events

Parameters:

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID or URL-encoded path of the group owned by the authenticated user
`milestone_id`	integer	yes	The ID of a group milestone