# GitLab Notes API

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

GitLab Notes 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 Notes. 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 the comments and system records attached to GitLab content. You can: - Create and modify comments on issues, merge requests, epics, snippets, commits, and wiki pages. - Retrieve [system-generated notes](https://docs.gitlab.com/user/project/system_notes/) about object changes. - Control visibility with confidential and internal flags. Some system-generated notes are tracked as separate resource events instead, including [label](https://docs.gitlab.com/api/resource_label_events/), [state](https://docs.gitlab.com/api/resource_state_events/), [milestone](https://docs.gitlab.com/api/resource_milestone_events/), [weight](https://docs.gitlab.com/api/resource_weight_events/), and [iteration](https://docs.gitlab.com/api/resource_iteration_events/) events. By default, `GET` requests return 20 results at a time, because the results are [paginated](https://docs.gitlab.com/api/rest/#pagination).

## Operations (35)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v4/projects/{id}/issues/{noteable_id}/notes` | List all issue notes |
| POST | `/api/v4/projects/{id}/issues/{noteable_id}/notes` | Create an issue note |
| GET | `/api/v4/projects/{id}/issues/{noteable_id}/notes/{note_id}` | Retrieve an issue note |
| PUT | `/api/v4/projects/{id}/issues/{noteable_id}/notes/{note_id}` | Update an issue note |
| DELETE | `/api/v4/projects/{id}/issues/{noteable_id}/notes/{note_id}` | Delete an issue note |
| GET | `/api/v4/projects/{id}/merge_requests/{noteable_id}/notes` | List all merge request notes |
| POST | `/api/v4/projects/{id}/merge_requests/{noteable_id}/notes` | Create a merge request note |
| GET | `/api/v4/projects/{id}/merge_requests/{noteable_id}/notes/{note_id}` | Retrieve a merge request note |
| PUT | `/api/v4/projects/{id}/merge_requests/{noteable_id}/notes/{note_id}` | Update a merge request note |
| DELETE | `/api/v4/projects/{id}/merge_requests/{noteable_id}/notes/{note_id}` | Delete a merge request note |
| GET | `/api/v4/projects/{id}/snippets/{noteable_id}/notes` | List all snippet notes |
| POST | `/api/v4/projects/{id}/snippets/{noteable_id}/notes` | Create a snippet note |
| GET | `/api/v4/projects/{id}/snippets/{noteable_id}/notes/{note_id}` | Retrieve a snippet note |
| PUT | `/api/v4/projects/{id}/snippets/{noteable_id}/notes/{note_id}` | Update a snippet note |
| DELETE | `/api/v4/projects/{id}/snippets/{noteable_id}/notes/{note_id}` | Delete a snippet note |
| GET | `/api/v4/projects/{id}/wiki_pages/{noteable_id}/notes` | List all wiki page meta notes |
| POST | `/api/v4/projects/{id}/wiki_pages/{noteable_id}/notes` | Create a wiki page meta note |
| GET | `/api/v4/projects/{id}/wiki_pages/{noteable_id}/notes/{note_id}` | Retrieve a wiki page meta note |
| PUT | `/api/v4/projects/{id}/wiki_pages/{noteable_id}/notes/{note_id}` | Update a wiki page meta note |
| DELETE | `/api/v4/projects/{id}/wiki_pages/{noteable_id}/notes/{note_id}` | Delete a wiki page meta note |
| GET | `/api/v4/groups/{id}/epics/{noteable_id}/notes` | List all epic notes |
| POST | `/api/v4/groups/{id}/epics/{noteable_id}/notes` | Create an epic note |
| GET | `/api/v4/groups/{id}/epics/{noteable_id}/notes/{note_id}` | Retrieve an epic note |
| PUT | `/api/v4/groups/{id}/epics/{noteable_id}/notes/{note_id}` | Update an epic note |
| DELETE | `/api/v4/groups/{id}/epics/{noteable_id}/notes/{note_id}` | Delete an epic note |
| GET | `/api/v4/projects/{id}/vulnerabilities/{noteable_id}/notes` | List all vulnerability notes |
| POST | `/api/v4/projects/{id}/vulnerabilities/{noteable_id}/notes` | Create a vulnerability note |
| GET | `/api/v4/projects/{id}/vulnerabilities/{noteable_id}/notes/{note_id}` | Retrieve a vulnerability note |
| PUT | `/api/v4/projects/{id}/vulnerabilities/{noteable_id}/notes/{note_id}` | Update a vulnerability note |
| DELETE | `/api/v4/projects/{id}/vulnerabilities/{noteable_id}/notes/{note_id}` | Delete a vulnerability note |
| GET | `/api/v4/groups/{id}/wiki_pages/{noteable_id}/notes` | List all wiki page meta notes |
| POST | `/api/v4/groups/{id}/wiki_pages/{noteable_id}/notes` | Create a wiki page meta note |
| GET | `/api/v4/groups/{id}/wiki_pages/{noteable_id}/notes/{note_id}` | Retrieve a wiki page meta note |
| PUT | `/api/v4/groups/{id}/wiki_pages/{noteable_id}/notes/{note_id}` | Update a wiki page meta note |
| DELETE | `/api/v4/groups/{id}/wiki_pages/{noteable_id}/notes/{note_id}` | Delete a wiki page meta note |

## Machine-readable artifacts (65)

- **OpenAPI** — https://artifacts.apis.io/gitlab/openapi/gitlab-notes-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

Notes

---

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