Skip to content
forgit api docs

List all board lists in an issue board

GET
/api/v4/projects/{id}/boards/{board_id}/lists

Lists all lists in a specified issue board. Does not include open and closed lists.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
One of:
string

The ID or URL-encoded path of the project

board_id
required
integer

The ID of a board

Query Parameters

Section titled “Query Parameters”
page
integer
default: 1 nullable

Current page number

Example
1
per_page
integer
default: 20 nullable

Number of items per page

Example
20

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
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
milestone
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
iteration
object
id
integer format: int64
iid
integer
sequence
integer
group_id
integer format: int64
title
string
description
string
state
integer
created_at
string format: date-time
updated_at
string format: date-time
start_date
string format: date
due_date
string format: date
web_url
string
assignee
object
id
integer format: int64
username
string
public_email
string
name
string
max_issue_count
integer
max_issue_weight
integer
limit_metric
string
Example
{
  "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,
  "iteration": {
    "id": 1,
    "iid": 1,
    "sequence": 1,
    "group_id": 1,
    "title": "Iteration I",
    "description": "Iteration description",
    "state": 1,
    "created_at": "2022-01-31T15:10:45.080Z",
    "updated_at": "2022-01-31T15:10:45.080Z",
    "start_date": "2022-01-01",
    "due_date": "2022-01-31",
    "web_url": "https://gitlab.example.com/groups/gitlab-org/-/iterations/1"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
    "public_email": "john@example.com",
    "name": "Administrator"
  },
  "max_issue_count": 0,
  "max_issue_weight": 0,
  "limit_metric": "issue_count"
}

400

Section titled “400”

Bad Request

404

Section titled “404”

Not Found