# GitLab Boards API

**Canonical:** https://apis.io/apis/gitlab/gitlab-boards-api/  
**Provider:** GitLab — https://apis.io/providers/gitlab/  
**Base URL:** https://gitlab.com/api/v4  
**Documentation:** https://docs.gitlab.com/api/rest/

GitLab Boards API is one of 189 APIs that [GitLab](https://apis.io/providers/gitlab/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification. This API exposes 16 JSON Schema definitions. Tagged areas include Boards. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, an API reference, rate-limit docs, an AsyncAPI specification, and 16 JSON Schemas.

Use this API to manage [issue boards](https://docs.gitlab.com/user/project/issue_board/) and their lists, for both projects and [groups](https://docs.gitlab.com/user/project/issue_board/#group-issue-boards). 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.

## Operations (20)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/v4/groups/{id}/boards` | Create a group issue board |
| GET | `/api/v4/groups/{id}/boards` | List all group issue boards in a group |
| DELETE | `/api/v4/groups/{id}/boards/{board_id}` | Delete a group issue board |
| GET | `/api/v4/groups/{id}/boards/{board_id}` | Retrieve a group issue board |
| PUT | `/api/v4/groups/{id}/boards/{board_id}` | Update a group issue board |
| GET | `/api/v4/groups/{id}/boards/{board_id}/lists` | List all group issue board lists |
| POST | `/api/v4/groups/{id}/boards/{board_id}/lists` | Create a group issue board list |
| GET | `/api/v4/groups/{id}/boards/{board_id}/lists/{list_id}` | Retrieve a group issue board list |
| PUT | `/api/v4/groups/{id}/boards/{board_id}/lists/{list_id}` | Update a group issue board list |
| DELETE | `/api/v4/groups/{id}/boards/{board_id}/lists/{list_id}` | Delete a group issue board list |
| GET | `/api/v4/projects/{id}/boards` | List all project issue boards |
| POST | `/api/v4/projects/{id}/boards` | Create an issue board |
| GET | `/api/v4/projects/{id}/boards/{board_id}` | Retrieve an issue board |
| PUT | `/api/v4/projects/{id}/boards/{board_id}` | Update an issue board |
| DELETE | `/api/v4/projects/{id}/boards/{board_id}` | Delete an issue board |
| GET | `/api/v4/projects/{id}/boards/{board_id}/lists` | List all board lists in an issue board |
| POST | `/api/v4/projects/{id}/boards/{board_id}/lists` | Create an issue board list |
| GET | `/api/v4/projects/{id}/boards/{board_id}/lists/{list_id}` | Retrieve a board list |
| PUT | `/api/v4/projects/{id}/boards/{board_id}/lists/{list_id}` | Update position of a board list |
| DELETE | `/api/v4/projects/{id}/boards/{board_id}/lists/{list_id}` | Delete a list from an issue board |

## Machine-readable artifacts (65)

- **OpenAPI** — https://artifacts.apis.io/gitlab/openapi/gitlab-boards-api-openapi.yml
- **Documentation** — https://docs.gitlab.com/api/openapi/
- **Documentation** — https://docs.gitlab.com/api/issues/
- **Authentication** — https://docs.gitlab.com/api/rest/authentication/
- **JSONSchema** — https://artifacts.apis.io/gitlab/json-schema/gitlab-put-api-v4-application-settings-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/gitlab/json-schema/gitlab-apientities-geo-node-status-schema.json
- **JSONSchema** — https://artifacts.apis.io/gitlab/json-schema/gitlab-apientities-geo-site-status-schema.json
- **JSONSchema** — https://artifacts.apis.io/gitlab/json-schema/gitlab-apientities-application-setting-schema.json
- **JSONSchema** — https://artifacts.apis.io/gitlab/json-schema/gitlab-post-api-v4-geo-status-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/gitlab/json-schema/gitlab-put-api-v4-projects-id-request-schema.json
- **Documentation** — https://docs.gitlab.com/api/merge_requests/
- **Documentation** — https://docs.gitlab.com/api/pipelines/
- **Documentation** — https://docs.gitlab.com/api/jobs/
- **Documentation** — https://docs.gitlab.com/api/runners/
- **Documentation** — https://docs.gitlab.com/api/users/
- **Documentation** — https://docs.gitlab.com/api/repositories/
- **Documentation** — https://docs.gitlab.com/api/commits/
- **Documentation** — https://docs.gitlab.com/api/branches/
- **Documentation** — https://docs.gitlab.com/api/tags/
- **Documentation** — https://docs.gitlab.com/api/releases/
- **Documentation** — https://docs.gitlab.com/api/environments/
- **Documentation** — https://docs.gitlab.com/api/deployments/
- **Documentation** — https://docs.gitlab.com/api/pipeline_schedules/
- **Documentation** — https://docs.gitlab.com/api/labels/
- **Documentation** — https://docs.gitlab.com/api/milestones/
- **Documentation** — https://docs.gitlab.com/api/notes/
- **Documentation** — https://docs.gitlab.com/api/snippets/
- **Documentation** — https://docs.gitlab.com/api/packages/
- **Documentation** — https://docs.gitlab.com/api/container_registry/
- **Documentation** — https://docs.gitlab.com/api/vulnerabilities/
- **Documentation** — https://docs.gitlab.com/api/deploy_keys/
- **Documentation** — https://docs.gitlab.com/api/protected_branches/
- **Documentation** — https://docs.gitlab.com/api/wikis/
- **Documentation** — https://docs.gitlab.com/api/events/
- **Documentation** — https://docs.gitlab.com/api/search/
- **Documentation** — https://docs.gitlab.com/api/namespaces/
- **Documentation** — https://docs.gitlab.com/api/groups/
- **Documentation** — https://docs.gitlab.com/api/projects/
- **Documentation** — https://docs.gitlab.com/api/applications/
- **Documentation** — https://docs.gitlab.com/api/avatar/
- …and 25 more, listed in full on the page.

## Other GitLab APIs (12)

- [GitLab Orbit gRPC API](https://apis.io/apis/gitlab/gitlab-orbit-api/)
- [GitLab GraphQL API](https://apis.io/apis/gitlab/gitlab-graphql-api/)
- [GitLab Applications API](https://apis.io/apis/gitlab/gitlab-applications-api/)
- [GitLab Authorization API](https://apis.io/apis/gitlab/gitlab-authorization-api/)
- [GitLab Broadcast Messages API](https://apis.io/apis/gitlab/gitlab-broadcast-messages-api/)
- [GitLab Groups API](https://apis.io/apis/gitlab/gitlab-groups-api/)
- [GitLab Metadata API](https://apis.io/apis/gitlab/gitlab-metadata-api/)
- [GitLab Project Webhooks API](https://apis.io/apis/gitlab/gitlab-project-webhooks-api/)
- [GitLab Projects API](https://apis.io/apis/gitlab/gitlab-projects-api/)
- [GitLab Tokens API](https://apis.io/apis/gitlab/gitlab-tokens-api/)
- [GitLab User Info API](https://apis.io/apis/gitlab/gitlab-user-info-api/)
- [GitLab Webhook Configuration API](https://apis.io/apis/gitlab/gitlab-webhook-configuration-api/)

## Tags

Boards

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/gitlab/gitlab-boards-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/gitlab/.