Group epic boards API
- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
Every API call to group 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.
GET /groups/:id/epic_boards
Attribute | Type | Required | Description |
---|---|---|---|
id | integer/string | yes | The ID or URL-encoded path of the group accessible by the authenticated user |
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/epic_boards"
Example response:
[
{
"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.
GET /groups/:id/epic_boards/:board_id
Attribute | Type | Required | Description |
---|---|---|---|
id | integer/string | yes | The ID or URL-encoded path of the group accessible by the authenticated user |
board_id | integer | yes | The ID of an epic board |
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/epic_boards/1"
Example response:
{
"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
Gets a list of the epic board’s lists.
Does not include open
and closed
lists.
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 accessible by the authenticated user |
board_id | integer | yes | The ID of an epic board |
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/epic_boards/1/lists"
Example response:
[
{
"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
Gets a single board list.
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 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 |
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/epic_boards/1/lists/1"
Example response:
{
"id" : 1,
"label" : {
"name" : "Testing",
"color" : "#F0AD4E",
"description" : null
},
"position" : 1,
"list_type" : "label",
"collapsed" : false
}
Docs
Edit this page to fix an error or add an improvement in a merge request.
Create an issue to suggest an improvement to this page.
Product
Create an issue if there's something you don't like about this feature.
Propose functionality by submitting a feature request.
Feature availability and product trials
View pricing to see all GitLab tiers and features, or to upgrade.
Try GitLab for free with access to all features for 30 days.
Get help
If you didn't find what you were looking for, search the docs.
If you want help with something specific and could use community support, post on the GitLab forum.
For problems setting up or using this feature (depending on your GitLab subscription).
Request support