List all group milestones

GET

/api/v4/groups/{id}/milestones

• GitLab REST API

Lists all group milestones for a specified group.

Authorizations

• http
• oauth2

Parameters

Path Parameters

id

required

string

The ID of a group

Query Parameters

state

string

default: all nullable

Allowed values: active closed all

Return “active”, “closed”, or “all” milestones

iids

Array<integer>

nullable

The IIDs of the milestones

title

string

nullable

The title of the milestones

search

string

nullable

The search criteria for the title or description of the milestone

include_parent_milestones

boolean

nullable

Deprecated: see include_ancestors

include_ancestors

boolean

nullable

Include milestones from all parent groups

updated_before

string format: date-time

nullable

Return milestones updated before the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ

updated_after

string format: date-time

nullable

Return milestones updated after the specified datetime. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ

page

integer

default: 1 nullable

Current page number

Example

1

per_page

integer

default: 20 nullable

Number of items per page

Example

20

include_descendants

boolean

nullable

Include milestones from all subgroups and subprojects

Responses

200

OK

Media type application/json

object

id

integer format: int64

iid

integer format: int64

project_id

integer format: int64

group_id

string

title

string

description

string

state

string

created_at

string

updated_at

string

due_date

string

start_date

string

expired

boolean

web_url

string

Example ^generated

{
  "id": 1,
  "iid": 1,
  "project_id": 1,
  "group_id": "example",
  "title": "example",
  "description": "example",
  "state": "example",
  "created_at": "example",
  "updated_at": "example",
  "due_date": "example",
  "start_date": "example",
  "expired": true,
  "web_url": "example"
}

400

Bad Request

404

Not Found