57 lines
1.8 KiB
Markdown
57 lines
1.8 KiB
Markdown
---
|
|
stage: Plan
|
|
group: Project Management
|
|
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
|
---
|
|
|
|
# Group iterations API **(PREMIUM)**
|
|
|
|
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/118742) in GitLab 13.5.
|
|
> - Moved to GitLab Premium in 13.9.
|
|
|
|
This page describes the group iterations API.
|
|
There's a separate [project iterations API](iterations.md) page.
|
|
|
|
## List group iterations
|
|
|
|
Returns a list of group iterations.
|
|
|
|
```plaintext
|
|
GET /groups/:id/iterations
|
|
GET /groups/:id/iterations?state=opened
|
|
GET /groups/:id/iterations?state=closed
|
|
GET /groups/:id/iterations?title=1.0
|
|
GET /groups/:id/iterations?search=version
|
|
```
|
|
|
|
| Attribute | Type | Required | Description |
|
|
| ------------------- | ------- | -------- | ----------- |
|
|
| `state` | string | no | Return only `opened`, `upcoming`, `started`, `closed`, or `all` iterations. Defaults to `all`. |
|
|
| `search` | string | no | Return only iterations with a title matching the provided string. |
|
|
| `include_ancestors` | boolean | no | Include iterations from parent group and its ancestors. Defaults to `true`. |
|
|
|
|
Example request:
|
|
|
|
```shell
|
|
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/iterations"
|
|
```
|
|
|
|
Example response:
|
|
|
|
```json
|
|
[
|
|
{
|
|
"id": 53,
|
|
"iid": 13,
|
|
"group_id": 5,
|
|
"title": "Iteration II",
|
|
"description": "Ipsum Lorem ipsum",
|
|
"state": 2,
|
|
"created_at": "2020-01-27T05:07:12.573Z",
|
|
"updated_at": "2020-01-27T05:07:12.573Z",
|
|
"due_date": "2020-02-01",
|
|
"start_date": "2020-02-14",
|
|
"web_url": "http://gitlab.example.com/groups/my-group/-/iterations/13"
|
|
}
|
|
]
|
|
```
|