Retrieve a group epic board

GET

/api/v4/groups/{id}/epic_boards/{board_id}

• GitLab REST API

Retrieves a specified group epic board. This feature was introduced in GitLab 15.9.

Authorizations

• http
• oauth2

Parameters

Path Parameters

id

required

string

The ID of a group

Example

1

board_id

required

integer

The ID of an epic board

Example

1

Responses

200

OK

Media type application/json

object

id

integer format: int64

name

string

hide_backlog_list

boolean

hide_closed_list

boolean

group

object

id

integer format: int64

web_url

string

name

string

labels

Array<object>

object

id

integer format: int64

name

string

description

string

text_color

string

description_html

string

color

string

archived

boolean

lists

Array<object>

object

id

integer format: int64

label

object

id

integer format: int64

name

string

description

string

text_color

string

description_html

string

color

string

archived

boolean

position

integer

list_type

string

Example

{
  "id": 1,
  "name": "Team Board",
  "hide_backlog_list": false,
  "hide_closed_list": true,
  "group": {
    "web_url": "http://gitlab.example.com/groups/diaspora",
    "name": "Diaspora"
  },
  "labels": [
    {
      "id": 1,
      "name": "bug",
      "description": "Bug reported by user",
      "text_color": "#FFFFFF",
      "description_html": "<p>Bug reported by user</p>",
      "color": "#FF0000",
      "archived": false
    }
  ],
  "lists": [
    {
      "id": 1,
      "label": {
        "id": 1,
        "name": "bug",
        "description": "Bug reported by user",
        "text_color": "#FFFFFF",
        "description_html": "<p>Bug reported by user</p>",
        "color": "#FF0000",
        "archived": false
      },
      "position": 1,
      "list_type": "backlog"
    }
  ]
}

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not found