Boards

Use this API to manage issue boards and their lists, for both projects and groups.

Every call to this API requires authentication. If the project or group is private and the authenticated user is not a member, a GET request results in a 404 status code.

List all group issue boards in a group

GET /api/v4/groups/{id}/boards

Lists all group issue boards for a specified group.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesBoard
`400`	Bad Request	—
`404`	Not Found	—

Retrieve a group issue board

GET /api/v4/groups/{id}/boards/{board_id}

Retrieves a specified group issue board.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group
`board_id` Path, required	Integer	The ID of a board

Responses

Code	Description	Schema
`200`	OK	APIEntitiesBoard
`400`	Bad Request	—
`404`	Not Found	—

Update a group issue board

PUT /api/v4/groups/{id}/boards/{board_id}

Updates a specified group issue board.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group
`board_id` Path, required	Integer	The ID of a board

Request body (application/json)

Property	Type	Description
`hide_backlog_list`	Boolean	Hide the Open list
`hide_closed_list`	Boolean	Hide the Closed list
`name`	String	The board name

Responses

Code	Description	Schema
`200`	OK	APIEntitiesBoard
`400`	Bad Request	—
`404`	Not Found	—

List all group issue board lists

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

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

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group
`board_id` Path, required	Integer	The ID of a board
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesList
`400`	Bad Request	—
`404`	Not Found	—

Create a group issue board list

POST /api/v4/groups/{id}/boards/{board_id}/lists

Creates a group issue board list for a specified board.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group
`board_id` Path, required	Integer	The ID of a board

Request body (application/json)

Property	Type	Description
`label_id` Required	Integer	The ID of an existing label

Responses

Code	Description	Schema
`201`	Created	APIEntitiesList
`400`	Bad Request	—
`404`	Not Found	—

Retrieve a group issue board list

GET /api/v4/groups/{id}/boards/{board_id}/lists/{list_id}

Retrieves a specified group issue board list.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group
`board_id` Path, required	Integer	The ID of a board
`list_id` Path, required	Integer	The ID of a list

Responses

Code	Description	Schema
`200`	OK	APIEntitiesList
`400`	Bad Request	—
`404`	Not Found	—

Update a group issue board list

PUT /api/v4/groups/{id}/boards/{board_id}/lists/{list_id}

Updates a specified group issue board list. This call is used to change list position.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group
`board_id` Path, required	Integer	The ID of a board
`list_id` Path, required	Integer	The ID of a list

Request body (application/json)

Property	Type	Description
`position` Required	Integer	The position of the list

Responses

Code	Description	Schema
`200`	OK	APIEntitiesList
`400`	Bad Request	—
`404`	Not Found	—

Delete a group issue board list

DELETE /api/v4/groups/{id}/boards/{board_id}/lists/{list_id}

Deletes a specified group issue board list. Only for administrators and users with the Owner role for the group.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a group
`board_id` Path, required	Integer	The ID of a board
`list_id` Path, required	Integer	The ID of a board list

Responses

Code	Description	Schema
`200`	OK	APIEntitiesList
`400`	Bad Request	—
`404`	Not Found	—

List all project issue boards

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

Lists all issue boards in a specified project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesBoard
`400`	Bad Request	—
`404`	Not Found	—

Create an issue board

POST /api/v4/projects/{id}/boards

Creates an issue board in a specified project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project

Request body (application/json)

Property	Type	Description
`name` Required	String	The board name

Responses

Code	Description	Schema
`201`	Created	APIEntitiesBoard
`400`	Bad Request	—
`404`	Not Found	—

Retrieve an issue board

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

Retrieves a specified issue board in a project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`board_id` Path, required	Integer	The ID of a board

Responses

Code	Description	Schema
`200`	OK	APIEntitiesBoard
`400`	Bad Request	—
`404`	Not Found	—

Update an issue board

PUT /api/v4/projects/{id}/boards/{board_id}

Updates a specified issue board in a project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`board_id` Path, required	Integer	The ID of a board

Request body (application/json)

Property	Type	Description
`hide_backlog_list`	Boolean	Hide the Open list
`hide_closed_list`	Boolean	Hide the Closed list
`name`	String	The board name

Responses

Code	Description	Schema
`200`	OK	APIEntitiesBoard
`400`	Bad Request	—
`404`	Not Found	—

Delete an issue board

DELETE /api/v4/projects/{id}/boards/{board_id}

Deletes a specified issue board in a project.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`board_id` Path, required	Integer	The ID of a board

Responses

Code	Description	Schema
`200`	OK	APIEntitiesBoard
`400`	Bad Request	—
`404`	Not Found	—

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.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`board_id` Path, required	Integer	The ID of a board
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesList
`400`	Bad Request	—
`404`	Not Found	—

Create an issue board list

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

Creates an issue board list.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`board_id` Path, required	Integer	The ID of a board

Request body (application/json)

Property	Type	Description
`label_id` Required	Integer	The ID of an existing label

Responses

Code	Description	Schema
`201`	Created	APIEntitiesList
`400`	Bad Request	—
`404`	Not Found	—

Retrieve a board list

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

Retrieves a specified list from an issue board.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`board_id` Path, required	Integer	The ID of a board
`list_id` Path, required	Integer	The ID of a list

Responses

Code	Description	Schema
`200`	OK	APIEntitiesList
`400`	Bad Request	—
`404`	Not Found	—

Update position of a board list

PUT /api/v4/projects/{id}/boards/{board_id}/lists/{list_id}

Updates the position of a specified list from an issue board.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`board_id` Path, required	Integer	The ID of a board
`list_id` Path, required	Integer	The ID of a list

Request body (application/json)

Property	Type	Description
`position` Required	Integer	The position of the list

Responses

Code	Description	Schema
`200`	OK	APIEntitiesList
`400`	Bad Request	—
`404`	Not Found	—

Delete a list from an issue board

DELETE /api/v4/projects/{id}/boards/{board_id}/lists/{list_id}

Deletes a specified list from an issue board.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`board_id` Path, required	Integer	The ID of a board
`list_id` Path, required	Integer	The ID of a board list

Responses

Code	Description	Schema
`200`	OK	APIEntitiesList
`400`	Bad Request	—
`404`	Not Found	—

Schemas

Objects returned by the operations above and objects nested in their request bodies.

APIEntitiesBasicProjectDetails

Property	Type	Description
`avatar_url`	String	Example: `http://example.com/uploads/project/avatar/3/uploads/avatar.png`
`created_at`	String (date-time)	Example: `2020-05-07T04:27:17.016Z`
`custom_attributes`	APIEntitiesCustomAttribute	—
`default_branch`	String	Example: `main`
`description`	String	Example: `desc`
`forks_count`	Integer	Example: `1`
`http_url_to_repo`	String	Example: `https://gitlab.example.com/gitlab/gitlab.git`
`id`	Integer (int64)	Example: `1`
`last_activity_at`	String (date-time)	Example: `2013-09-30T13:46:02Z`
`license`	APIEntitiesLicenseBasic	—
`license_url`	String	Example: `https://gitlab.example.com/gitlab/gitlab/blob/master/LICENCE`
`name`	String	Example: `project1`
`name_with_namespace`	String	Example: `John Doe / project1`
`namespace`	APIEntitiesNamespaceBasic	—
`path`	String	Example: `project1`
`path_with_namespace`	String	Example: `namespace1/project1`
`readme_url`	String	Example: `https://gitlab.example.com/gitlab/gitlab/blob/master/README.md`
`repository_storage`	String	Example: `default`
`ssh_url_to_repo`	String	Example: `git@gitlab.example.com:gitlab/gitlab.git`
`star_count`	Integer	Example: `1`
`tag_list`	Array of strings	Example: `["tag"]`
`topics`	Array of strings	Example: `["topic"]`
`visibility`	String	Example: `public`
`web_url`	String	Example: `https://gitlab.example.com/gitlab/gitlab`

APIEntitiesBoard

Property	Type	Description
`hide_backlog_list`	Boolean	Example: `false`
`hide_closed_list`	Boolean	Example: `false`
`id`	Integer (int64)	Example: `1`
`lists`	Array of APIEntitiesList	—
`name`	String	Example: `Development`
`project`	APIEntitiesBasicProjectDetails	—

APIEntitiesCustomAttribute

Property	Type	Description
`key`	String	Example: `foo`
`value`	String	Example: `bar`

APIEntitiesLabelBasic

Property	Type	Description
`archived`	Boolean	Example: `false`
`color`	String	Example: `#FF0000`
`description`	String	Example: `Bug reported by user`
`description_html`	String	Example: `<p>Bug reported by user</p>`
`id`	Integer (int64)	Example: `1`
`name`	String	Example: `bug`
`text_color`	String	Example: `#FFFFFF`

APIEntitiesLicenseBasic

Property	Type	Description
`html_url`	String	Example: `http://choosealicense.com/licenses/gpl-3.0`
`key`	String	Example: `gpl-3.0`
`name`	String	Example: `GNU General Public License v3.0`
`nickname`	String	Example: `GNU GPLv3`
`source_url`	String	—

APIEntitiesList

Property	Type	Description
`id`	Integer (int64)	Example: `1`
`label`	APIEntitiesLabelBasic	—
`position`	Integer	Example: `1`

APIEntitiesNamespaceBasic

Property	Type	Description
`avatar_url`	String	Example: `https://example.com/avatar/12345`
`full_path`	String	Example: `group/my_project`
`id`	Integer (int64)	Example: `2`
`kind`	String	Example: `project`
`name`	String	Example: `project`
`parent_id`	Integer (int64)	Example: `1`
`path`	String	Example: `my_project`
`web_url`	String	Example: `https://example.com/group/my_project`

List all group issue boards in a group

Retrieve a group issue board

Update a group issue board

List all group issue board lists

Create a group issue board list

Retrieve a group issue board list

Update a group issue board list

Delete a group issue board list

List all project issue boards

Create an issue board

Retrieve an issue board

Update an issue board

Delete an issue board

List all board lists in an issue board

Create an issue board list

Retrieve a board list

Update position of a board list

Delete a list from an issue board

Schemas

APIEntitiesBasicProjectDetails

APIEntitiesBoard

APIEntitiesCustomAttribute

APIEntitiesLabelBasic

APIEntitiesLicenseBasic

APIEntitiesList

APIEntitiesNamespaceBasic

Request trial access

Thank you

Error

Request callback

Thank you

Something went wrong

Book your sessions

Thank you

Error

Request demo

Thank you

Error

Get the PCI SSC Compliance Report

Thank you

Error