1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
|
---
stage: Plan
group: Product Planning
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
---
# Group epic boards API **(PREMIUM ALL)**
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385903) in GitLab 15.9.
Every API call to [group epic boards](../user/group/epics/epic_boards.md#epic-boards) must be authenticated.
If a user is not a member of a group and the group is private, a `GET`
request results in `404` status code.
## List all epic boards in a group
Lists epic boards in the given group.
```plaintext
GET /groups/:id/epic_boards
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) accessible by the authenticated user |
```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/epic_boards"
```
Example response:
```json
[
{
"id": 1,
"name": "group epic board",
"group": {
"id": 5,
"name": "Documentcloud",
"web_url": "http://example.com/groups/documentcloud"
},
"hide_backlog_list": false,
"hide_closed_list": false,
"labels": [
{
"id": 1,
"title": "Board Label",
"color": "#c21e56",
"description": "label applied to the epic board",
"group_id": 5,
"project_id": null,
"template": false,
"text_color": "#FFFFFF",
"created_at": "2023-01-27T10:40:59.738Z",
"updated_at": "2023-01-27T10:40:59.738Z"
}
],
"lists": [
{
"id": 1,
"label": {
"id": 69,
"name": "Testing",
"color": "#F0AD4E",
"description": null
},
"position": 1,
"list_type": "label"
},
{
"id": 2,
"label": {
"id": 70,
"name": "Ready",
"color": "#FF0000",
"description": null
},
"position": 2,
"list_type": "label"
},
{
"id": 3,
"label": {
"id": 71,
"name": "Production",
"color": "#FF5F00",
"description": null
},
"position": 3,
"list_type": "label"
}
]
}
]
```
## Single group epic board
Gets a single group epic board.
```plaintext
GET /groups/:id/epic_boards/:board_id
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) accessible by the authenticated user |
| `board_id` | integer | yes | The ID of an epic board |
```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/epic_boards/1"
```
Example response:
```json
{
"id": 1,
"name": "group epic board",
"group": {
"id": 5,
"name": "Documentcloud",
"web_url": "http://example.com/groups/documentcloud"
},
"labels": [
{
"id": 1,
"title": "Board Label",
"color": "#c21e56",
"description": "label applied to the epic board",
"group_id": 5,
"project_id": null,
"template": false,
"text_color": "#FFFFFF",
"created_at": "2023-01-27T10:40:59.738Z",
"updated_at": "2023-01-27T10:40:59.738Z"
}
],
"lists" : [
{
"id" : 1,
"label" : {
"id": 69,
"name" : "Testing",
"color" : "#F0AD4E",
"description" : null
},
"position" : 1,
"list_type": "label"
},
{
"id" : 2,
"label" : {
"id": 70,
"name" : "Ready",
"color" : "#FF0000",
"description" : null
},
"position" : 2,
"list_type": "label"
},
{
"id" : 3,
"label" : {
"id": 71,
"name" : "Production",
"color" : "#FF5F00",
"description" : null
},
"position" : 3,
"list_type": "label"
}
]
}
```
## List group epic board lists
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385904) in GitLab 15.9.
Gets a list of the epic board's lists.
Does not include `open` and `closed` lists.
```plaintext
GET /groups/:id/epic_boards/:board_id/lists
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) accessible by the authenticated user |
| `board_id` | integer | yes | The ID of an epic board |
```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/epic_boards/1/lists"
```
Example response:
```json
[
{
"id" : 1,
"label" : {
"name" : "Testing",
"color" : "#F0AD4E",
"description" : null
},
"position" : 1,
"list_type" : "label",
"collapsed" : false
},
{
"id" : 2,
"label" : {
"name" : "Ready",
"color" : "#FF0000",
"description" : null
},
"position" : 2,
"list_type" : "label",
"collapsed" : false
},
{
"id" : 3,
"label" : {
"name" : "Production",
"color" : "#FF5F00",
"description" : null
},
"position" : 3,
"list_type" : "label",
"collapsed" : false
}
]
```
## Single group epic board list
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/385904) in GitLab 15.9.
Gets a single board list.
```plaintext
GET /groups/:id/epic_boards/:board_id/lists/:list_id
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding) accessible by the authenticated user |
| `board_id` | integer | yes | The ID of an epic board |
| `list_id` | integer | yes | The ID of an epic board's list |
```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/epic_boards/1/lists/1"
```
Example response:
```json
{
"id" : 1,
"label" : {
"name" : "Testing",
"color" : "#F0AD4E",
"description" : null
},
"position" : 1,
"list_type" : "label",
"collapsed" : false
}
```
|
