[Skip to main content](https://docs.gitlab.com/api/notes/#skipTarget) [Go to GitLab Docs homepage](https://docs.gitlab.com/)
`/`
[What's new?](https://about.gitlab.com/releases/whats-new/)
English
  * Language
  * English
  * 日本語


v18.10
  *     * [18.10 (not yet released)](https://docs.gitlab.com/api/notes/)
  *     * [18.9 (recently released)](https://docs.gitlab.com/18.9/api/notes/)
    * [18.8](https://docs.gitlab.com/18.8/api/notes/)
    * [18.7](https://archives.docs.gitlab.com/18.7/api/notes/)
  *     * [17.11](https://archives.docs.gitlab.com/17.11/api/notes/)
    * [16.11](https://archives.docs.gitlab.com/16.11/ee/api/notes.html)
  *     * [Archives](https://docs.gitlab.com/archives)


Select theme and layout
  * Light mode
  * Dark mode
  * Auto


  * Fixed width
  * Fluid width


[What's new?](https://about.gitlab.com/releases/whats-new/) [Get free trial](https://gitlab.com/-/trial_registrations/new?glm_source=docs.gitlab.com&amp;glm_content=navigation-cta-docs)
Toggle menu
  * [Use GitLab](https://docs.gitlab.com/user/)
  * [GitLab Duo](https://docs.gitlab.com/user/gitlab_duo/)
  * [Extend](https://docs.gitlab.com/api/)
  * [Install](https://docs.gitlab.com/install/)
  * [Administer](https://docs.gitlab.com/administration/)
  * [Subscribe](https://docs.gitlab.com/subscriptions/)
  * [Contribute](https://docs.gitlab.com/development/)
  * [Solutions](https://docs.gitlab.com/solutions/)


Select a topicUse GitLab GitLab Duo Extend Install Administer Subscribe Contribute Solutions
[Getting started](https://docs.gitlab.com/api/get_started/get_started_extending/)
[Tutorials](https://docs.gitlab.com/tutorials/develop/)
[Integrations](https://docs.gitlab.com/integration/)
[Webhooks](https://docs.gitlab.com/user/project/integrations/webhooks/)
[REST API](https://docs.gitlab.com/api/rest/)
[Resources](https://docs.gitlab.com/api/api_resources/)
[.gitignore (templates)](https://docs.gitlab.com/api/templates/gitignores/)
[.gitlab-ci.yml (templates)](https://docs.gitlab.com/api/templates/gitlab_ci_ymls/)
[Access requests](https://docs.gitlab.com/api/access_requests/)
[Agent for Kubernetes](https://docs.gitlab.com/api/cluster_agents/)
[AI Catalog admin](https://docs.gitlab.com/api/admin/ai_catalog/)
[Alert management](https://docs.gitlab.com/api/alert_management_alerts/)
[Application appearance](https://docs.gitlab.com/api/appearance/)
[Application settings](https://docs.gitlab.com/api/settings/)
[Application statistics](https://docs.gitlab.com/api/statistics/)
[Applications](https://docs.gitlab.com/api/applications/)
[Attestations](https://docs.gitlab.com/api/attestations/)
[Audit events](https://docs.gitlab.com/api/audit_events/)
[Avatar](https://docs.gitlab.com/api/avatar/)
[Branches](https://docs.gitlab.com/api/branches/)
[Broadcast messages](https://docs.gitlab.com/api/broadcast_messages/)
[Cluster discovery (certificate-based) (deprecated)](https://docs.gitlab.com/api/cluster_discovery/)
[Code Suggestions](https://docs.gitlab.com/api/code_suggestions/)
[Commits](https://docs.gitlab.com/api/commits/)
[Compliance and policy settings](https://docs.gitlab.com/api/compliance_policy_settings/)
[Composer](https://docs.gitlab.com/api/packages/composer/)
[Conan v1](https://docs.gitlab.com/api/packages/conan_v1/)
[Conan v2](https://docs.gitlab.com/api/packages/conan_v2/)
[Container registry](https://docs.gitlab.com/api/container_registry/)
[Container repository protection rules](https://docs.gitlab.com/api/container_repository_protection_rules/)
[Container registry protection tag rules](https://docs.gitlab.com/api/container_registry_protection_tag_rules/)
[Container virtual registry](https://docs.gitlab.com/api/container_virtual_registries/)
[Custom attributes](https://docs.gitlab.com/api/custom_attributes/)
[Database migrations](https://docs.gitlab.com/api/database_migrations/)
[Data management](https://docs.gitlab.com/api/admin/data_management/)
[Debian](https://docs.gitlab.com/api/packages/debian/)
[Debian group distributions](https://docs.gitlab.com/api/packages/debian_group_distributions/)
[Debian project distributions](https://docs.gitlab.com/api/packages/debian_project_distributions/)
[Dependencies](https://docs.gitlab.com/api/dependencies/)
[Dependency list export](https://docs.gitlab.com/api/dependency_list_export/)
[Dependency Proxy](https://docs.gitlab.com/api/dependency_proxy/)
[Deploy keys](https://docs.gitlab.com/api/deploy_keys/)
[Deploy tokens](https://docs.gitlab.com/api/deploy_tokens/)
[Deployments](https://docs.gitlab.com/api/deployments/)
[Discussions](https://docs.gitlab.com/api/discussions/)
[Dockerfile (templates)](https://docs.gitlab.com/api/templates/dockerfiles/)
[DORA4 metrics](https://docs.gitlab.com/api/dora/metrics/)
[Emoji reactions](https://docs.gitlab.com/api/emoji_reactions/)
[Environments](https://docs.gitlab.com/api/environments/)
[Epics (deprecated)](https://docs.gitlab.com/api/epics/)
[Error tracking](https://docs.gitlab.com/api/error_tracking/)
[Events](https://docs.gitlab.com/api/events/)
[Experiments](https://docs.gitlab.com/api/experiments/)
[External status checks](https://docs.gitlab.com/api/status_checks/)
[Feature flags](https://docs.gitlab.com/api/feature_flags/)
[Feature flag user lists](https://docs.gitlab.com/api/feature_flag_user_lists/)
[Freeze periods](https://docs.gitlab.com/api/freeze_periods/)
[Geo nodes (deprecated)](https://docs.gitlab.com/api/geo_nodes/)
[Geo sites](https://docs.gitlab.com/api/geo_sites/)
[GitLab Duo Chat completions](https://docs.gitlab.com/api/chat/)
[GitLab Pages](https://docs.gitlab.com/api/pages/)
[GLQL](https://docs.gitlab.com/api/glql/)
[Go Proxy](https://docs.gitlab.com/api/packages/go_proxy/)
[Google Cloud integration](https://docs.gitlab.com/api/google_cloud_integration/)
[Groups](https://docs.gitlab.com/api/groups/)
[Helm](https://docs.gitlab.com/api/packages/helm/)
[Import](https://docs.gitlab.com/api/import/)
[Instance CI/CD variables](https://docs.gitlab.com/api/instance_level_ci_variables/)
[Invitations](https://docs.gitlab.com/api/invitations/)
[Issues](https://docs.gitlab.com/api/issues/)
[Issues (epic) (deprecated)](https://docs.gitlab.com/api/epic_issues/)
[Issues statistics](https://docs.gitlab.com/api/issues_statistics/)
[Jobs](https://docs.gitlab.com/api/jobs/)
[Job artifacts](https://docs.gitlab.com/api/job_artifacts/)
[Job token scopes](https://docs.gitlab.com/api/project_job_token_scopes/)
[Keys](https://docs.gitlab.com/api/keys/)
[License](https://docs.gitlab.com/api/license/)
[Licenses (templates)](https://docs.gitlab.com/api/templates/licenses/)
[Linked epics (deprecated)](https://docs.gitlab.com/api/linked_epics/)
[Links (issue)](https://docs.gitlab.com/api/issue_links/)
[Links (epic) (deprecated)](https://docs.gitlab.com/api/epic_links/)
[Lint .gitlab-ci.yml](https://docs.gitlab.com/api/lint/)
[Markdown](https://docs.gitlab.com/api/markdown/)
[Maven](https://docs.gitlab.com/api/packages/maven/)
[Maven virtual registry](https://docs.gitlab.com/api/maven_virtual_registries/)
[Member roles](https://docs.gitlab.com/api/member_roles/)
[Merge request approvals](https://docs.gitlab.com/api/merge_request_approvals/)
[Merge request approval settings](https://docs.gitlab.com/api/merge_request_approval_settings/)
[Merge request context commits](https://docs.gitlab.com/api/merge_request_context_commits/)
[Merge requests](https://docs.gitlab.com/api/merge_requests/)
[Merge trains](https://docs.gitlab.com/api/merge_trains/)
[Metadata](https://docs.gitlab.com/api/metadata/)
[Model registry](https://docs.gitlab.com/api/model_registry/)
[Namespaces](https://docs.gitlab.com/api/namespaces/)
[Notes (comments)](https://docs.gitlab.com/api/notes/)
[Draft notes](https://docs.gitlab.com/api/draft_notes/)
[Notification settings](https://docs.gitlab.com/api/notification_settings/)
[npm](https://docs.gitlab.com/api/packages/npm/)
[NuGet](https://docs.gitlab.com/api/packages/nuget/)
[Organizations](https://docs.gitlab.com/api/organizations/)
[Packages](https://docs.gitlab.com/api/packages/)
[Pages domains](https://docs.gitlab.com/api/pages_domains/)
[Personal access tokens](https://docs.gitlab.com/api/personal_access_tokens/)
[Pipeline schedules](https://docs.gitlab.com/api/pipeline_schedules/)
[Pipeline trigger tokens](https://docs.gitlab.com/api/pipeline_triggers/)
[Pipelines](https://docs.gitlab.com/api/pipelines/)
[Plan limits](https://docs.gitlab.com/api/plan_limits/)
[Product analytics](https://docs.gitlab.com/api/product_analytics/)
[Projects](https://docs.gitlab.com/api/projects/)
[PyPI](https://docs.gitlab.com/api/packages/pypi/)
[Repositories](https://docs.gitlab.com/api/repositories/)
[Repository files](https://docs.gitlab.com/api/repository_files/)
[Repository submodules](https://docs.gitlab.com/api/repository_submodules/)
[Resource group](https://docs.gitlab.com/api/resource_groups/)
[Resource iteration events](https://docs.gitlab.com/api/resource_iteration_events/)
[Resource label events](https://docs.gitlab.com/api/resource_label_events/)
[Resource milestone events](https://docs.gitlab.com/api/resource_milestone_events/)
[Resource state events](https://docs.gitlab.com/api/resource_state_events/)
[Resource weight events](https://docs.gitlab.com/api/resource_weight_events/)
[Ruby gems](https://docs.gitlab.com/api/packages/rubygems/)
[Runners](https://docs.gitlab.com/api/runners/)
[Runner controllers](https://docs.gitlab.com/api/runner_controllers/)
[Runner controller tokens](https://docs.gitlab.com/api/runner_controller_tokens/)
[Search](https://docs.gitlab.com/api/search/)
[Search migrations](https://docs.gitlab.com/api/search_admin/)
[Secure files](https://docs.gitlab.com/api/secure_files/)
[Service accounts](https://docs.gitlab.com/api/service_accounts/)
[Service Ping](https://docs.gitlab.com/api/usage_data/)
[Sidekiq metrics](https://docs.gitlab.com/api/sidekiq_metrics/)
[Sidekiq queues](https://docs.gitlab.com/api/admin_sidekiq_queues/)
[Snippet repository storage moves](https://docs.gitlab.com/api/snippet_repository_storage_moves/)
[Snippets](https://docs.gitlab.com/api/snippets/)
[Suggestions](https://docs.gitlab.com/api/suggestions/)
[System hooks](https://docs.gitlab.com/api/system_hooks/)
[Tags](https://docs.gitlab.com/api/tags/)
[Terraform registry](https://docs.gitlab.com/api/packages/terraform-modules/)
[To-Do List](https://docs.gitlab.com/api/todos/)
[Token information](https://docs.gitlab.com/api/admin/token/)
[Topics](https://docs.gitlab.com/api/topics/)
[Users](https://docs.gitlab.com/api/users/)
[Version](https://docs.gitlab.com/api/version/)
[Virtual registries cleanup policies](https://docs.gitlab.com/api/virtual_registries_cleanup_policies/)
[Vulnerabilities](https://docs.gitlab.com/api/vulnerabilities/)
[Vulnerability archive export](https://docs.gitlab.com/api/vulnerability_archive_exports/)
[Vulnerability export](https://docs.gitlab.com/api/vulnerability_exports/)
[Vulnerability findings](https://docs.gitlab.com/api/vulnerability_findings/)
[Web commits](https://docs.gitlab.com/api/web_commits/)
[Authentication](https://docs.gitlab.com/api/rest/authentication/)
[Third-party clients](https://docs.gitlab.com/api/rest/third_party_clients/)
[Deprecations and removals](https://docs.gitlab.com/api/rest/deprecations/)
[OpenAPI](https://docs.gitlab.com/api/openapi/openapi_interactive/)
[Automate storage management](https://docs.gitlab.com/user/storage_management_automation/)
[Troubleshooting](https://docs.gitlab.com/api/rest/troubleshooting/)
[GraphQL API](https://docs.gitlab.com/api/graphql/)
[OAuth 2.0 identity provider API](https://docs.gitlab.com/api/oauth2/)
[GitLab Duo CLI (duo)](https://docs.gitlab.com/user/gitlab_duo_cli/)
[GitLab CLI (glab)](https://docs.gitlab.com/cli/)
[Editor and IDE extensions](https://docs.gitlab.com/editor_extensions/)
/
  1. [GitLab Docs](https://docs.gitlab.com/)
  2. [Extend](https://docs.gitlab.com/api/)
  3. [REST API](https://docs.gitlab.com/api/rest/)
  4. [Resources](https://docs.gitlab.com/api/api_resources/)
  5. [Notes (comments)](https://docs.gitlab.com/api/notes/)


* * *
# Notes API
  * Tier: Free, Premium, Ultimate
  * Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated


Use this API to manage comments and system records attached to GitLab content. You can:
  * Create and modify comments on issues, merge requests, epics, snippets, and commits.
  * Retrieve [system-generated notes](https://docs.gitlab.com/user/project/system_notes/) about object changes.
  * Sort and paginate results.
  * Control visibility with confidential and internal flags.
  * Prevent abuse with rate limiting.


Some system-generated notes are tracked as separate resource events:
  * [Resource label events](https://docs.gitlab.com/api/resource_label_events/)
  * [Resource state events](https://docs.gitlab.com/api/resource_state_events/)
  * [Resource milestone events](https://docs.gitlab.com/api/resource_milestone_events/)
  * [Resource weight events](https://docs.gitlab.com/api/resource_weight_events/)
  * [Resource iteration events](https://docs.gitlab.com/api/resource_iteration_events/)


By default, `GET` requests return 20 results at a time, because the API results are paginated. For more information, see [Pagination](https://docs.gitlab.com/api/rest/#pagination).
## Resource events[](https://docs.gitlab.com/api/notes/#resource-events "Permalink")
Some system notes are not part of this API, but are recorded as separate events:
  * [Resource label events](https://docs.gitlab.com/api/resource_label_events/)
  * [Resource state events](https://docs.gitlab.com/api/resource_state_events/)
  * [Resource milestone events](https://docs.gitlab.com/api/resource_milestone_events/)
  * [Resource weight events](https://docs.gitlab.com/api/resource_weight_events/)
  * [Resource iteration events](https://docs.gitlab.com/api/resource_iteration_events/)


## Notes pagination[](https://docs.gitlab.com/api/notes/#notes-pagination "Permalink")
By default, `GET` requests return 20 results at a time because the API results are paginated.
Read more on [pagination](https://docs.gitlab.com/api/rest/#pagination).
## Rate limits[](https://docs.gitlab.com/api/notes/#rate-limits "Permalink")
To help avoid abuse, you can limit your users to a specific number of `Create` request per minute. See [Notes rate limits](https://docs.gitlab.com/administration/settings/rate_limit_on_notes_creation/).
## Issues[](https://docs.gitlab.com/api/notes/#issues "Permalink")
### List all issue notes[](https://docs.gitlab.com/api/notes/#list-all-issue-notes "Permalink")
Lists all notes for a specified issue.
```
GET /projects/:id/issues/:issue_iid/notes
GET /projects/:id/issues/:issue_iid/notes?sort=asc&order_by=updated_at
GET /projects/:id/issues/:issue_iid/notes?activity_filter=only_comments
```

Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | yes | The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths)
`issue_iid` | integer | yes | The IID of an issue
`activity_filter` | string | no | Filter notes by activity type. Valid values: `all_notes`, `only_comments`, `only_activity`. Default is `all_notes`
`sort` | string | no | Return issue notes sorted in `asc` or `desc` order. Default is `desc`
`order_by` | string | no | Return issue notes ordered by `created_at` or `updated_at` fields. Default is `created_at`
json
```
[
  {
    "id": 302,
    "body": "closed",
    "author": {
      "id": 1,
      "username": "pipin",
      "email": "admin@example.com",
      "name": "Pip",
      "state": "active",
      "created_at": "2013-09-30T13:46:01Z"
    },
    "created_at": "2013-10-02T09:22:45Z",
    "updated_at": "2013-10-02T10:22:45Z",
    "system": true,
    "noteable_id": 377,
    "noteable_type": "Issue",
    "project_id": 5,
    "noteable_iid": 377,
    "resolvable": false,
    "confidential": false,
    "internal": false,
    "imported": false,
    "imported_from": "none"
  },
  {
    "id": 305,
    "body": "Text of the comment\r\n",
    "author": {
      "id": 1,
      "username": "pipin",
      "email": "admin@example.com",
      "name": "Pip",
      "state": "active",
      "created_at": "2013-09-30T13:46:01Z"
    },
    "created_at": "2013-10-02T09:56:03Z",
    "updated_at": "2013-10-02T09:56:03Z",
    "system": true,
    "noteable_id": 121,
    "noteable_type": "Issue",
    "project_id": 5,
    "noteable_iid": 121,
    "resolvable": false,
    "confidential": true,
    "internal": true,
    "imported": false,
    "imported_from": "none"
  }
]
```

shell
```
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/issues/11/notes"
```

### Retrieve an issue note[](https://docs.gitlab.com/api/notes/#retrieve-an-issue-note "Permalink")
Retrieves a specified note for a project issue.
```
GET /projects/:id/issues/:issue_iid/notes/:note_id
```

Parameters:
Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | yes | The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths)
`issue_iid` | integer | yes | The IID of a project issue
`note_id` | integer | yes | The ID of an issue note
shell
```
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/issues/11/notes/1"
```

### Create an issue note[](https://docs.gitlab.com/api/notes/#create-an-issue-note "Permalink")
Creates a note for a specified project issue.
```
POST /projects/:id/issues/:issue_iid/notes
```

Parameters:
Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | yes | The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
`issue_iid` | integer | yes | The IID of an issue.
`body` | string | yes | The content of a note. Limited to 1,000,000 characters.
`confidential` | boolean | no |  **Deprecated** : Scheduled to be removed in GitLab 16.0 and renamed to `internal`. The confidential flag of a note. Default is false.
`internal` | boolean | no | The internal flag of a note. Overrides `confidential` when both parameters are submitted. Default is false.
`created_at` | string | no | Date time string, ISO 8601 formatted. It must be after 1970-01-01. Example: `2016-03-11T03:45:40Z` (requires administrator or project/group owner rights)
shell
```
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/issues/11/notes?body=note"
```

### Update an issue note[](https://docs.gitlab.com/api/notes/#update-an-issue-note "Permalink")
Updates a specified note of an issue.
```
PUT /projects/:id/issues/:issue_iid/notes/:note_id
```

Parameters:
Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | yes | The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths).
`issue_iid` | integer | yes | The IID of an issue.
`note_id` | integer | yes | The ID of a note.
`body` | string | no | The content of a note. Limited to 1,000,000 characters.
`confidential` | boolean | no |  **Deprecated** : Scheduled to be removed in GitLab 16.0. The confidential flag of a note. Default is false.
shell
```
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/issues/11/notes/636?body=note"
```

### Delete an issue note[](https://docs.gitlab.com/api/notes/#delete-an-issue-note "Permalink")
Deletes an existing note of an issue.
```
DELETE /projects/:id/issues/:issue_iid/notes/:note_id
```

Parameters:
Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | yes | The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths)
`issue_iid` | integer | yes | The IID of an issue
`note_id` | integer | yes | The ID of a note
shell
```
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/issues/11/notes/636"
```

## Snippets[](https://docs.gitlab.com/api/notes/#snippets "Permalink")
The Snippets Notes API is intended for project-level snippets, and not for personal snippets.
### List all snippet notes[](https://docs.gitlab.com/api/notes/#list-all-snippet-notes "Permalink")
Lists all notes for a specified snippet. Snippet notes are comments users can post to a snippet.
```
GET /projects/:id/snippets/:snippet_id/notes
GET /projects/:id/snippets/:snippet_id/notes?sort=asc&order_by=updated_at
```

Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | yes | The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths)
`snippet_id` | integer | yes | The ID of a project snippet
`sort` | string | no | Return snippet notes sorted in `asc` or `desc` order. Default is `desc`
`order_by` | string | no | Return snippet notes ordered by `created_at` or `updated_at` fields. Default is `created_at`
shell
```
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/snippets/11/notes"
```

### Retrieve a snippet note[](https://docs.gitlab.com/api/notes/#retrieve-a-snippet-note "Permalink")
Retrieves a specified note for a snippet.
```
GET /projects/:id/snippets/:snippet_id/notes/:note_id
```

Parameters:
Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | yes | The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths)
`snippet_id` | integer | yes | The ID of a project snippet
`note_id` | integer | yes | The ID of a snippet note
json
```
{
  "id": 302,
  "body": "closed",
  "author": {
    "id": 1,
    "username": "pipin",
    "email": "admin@example.com",
    "name": "Pip",
    "state": "active",
    "created_at": "2013-09-30T13:46:01Z"
  },
  "created_at": "2013-10-02T09:22:45Z",
  "updated_at": "2013-10-02T10:22:45Z",
  "system": true,
  "noteable_id": 377,
  "noteable_type": "Issue",
  "project_id": 5,
  "noteable_iid": 377,
  "resolvable": false,
  "confidential": false,
  "internal": false,
  "imported": false,
  "imported_from": "none"
}
```

shell
```
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/snippets/11/notes/11"
```

### Create a snippet note[](https://docs.gitlab.com/api/notes/#create-a-snippet-note "Permalink")
Creates a new note for a specified snippet. Snippet notes are user comments on snippets. If you create a note where the body only contains an emoji reaction, GitLab returns this object.
```
POST /projects/:id/snippets/:snippet_id/notes
```

Parameters:
Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | yes | The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths)
`snippet_id` | integer | yes | The ID of a snippet
`body` | string | yes | The content of a note. Limited to 1,000,000 characters.
`created_at` | string | no | Date time string, ISO 8601 formatted. Example: `2016-03-11T03:45:40Z` (requires administrator or project/group owner rights)
shell
```
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/snippet/11/notes?body=note"
```

### Update a snippet note[](https://docs.gitlab.com/api/notes/#update-a-snippet-note "Permalink")
Updates a specified note of a snippet.
```
PUT /projects/:id/snippets/:snippet_id/notes/:note_id
```

Parameters:
Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | yes | The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths)
`snippet_id` | integer | yes | The ID of a snippet
`note_id` | integer | yes | The ID of a snippet note
`body` | string | yes | The content of a note. Limited to 1,000,000 characters.
shell
```
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/snippets/11/notes/1659?body=note"
```

### Delete a snippet note[](https://docs.gitlab.com/api/notes/#delete-a-snippet-note "Permalink")
Deletes an existing note of a snippet.
```
DELETE /projects/:id/snippets/:snippet_id/notes/:note_id
```

Parameters:
Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | yes | The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths)
`snippet_id` | integer | yes | The ID of a snippet
`note_id` | integer | yes | The ID of a note
shell
```
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/snippets/52/notes/1659"
```

## Merge requests[](https://docs.gitlab.com/api/notes/#merge-requests "Permalink")
### List all merge request notes[](https://docs.gitlab.com/api/notes/#list-all-merge-request-notes "Permalink")
Lists all notes for a specified merge request.
```
GET /projects/:id/merge_requests/:merge_request_iid/notes
GET /projects/:id/merge_requests/:merge_request_iid/notes?sort=asc&order_by=updated_at
```

Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | yes | The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths)
`merge_request_iid` | integer | yes | The IID of a project merge request
`sort` | string | no | Return merge request notes sorted in `asc` or `desc` order. Default is `desc`
`order_by` | string | no | Return merge request notes ordered by `created_at` or `updated_at` fields. Default is `created_at`
shell
```
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/notes"
```

### Retrieve a merge request note[](https://docs.gitlab.com/api/notes/#retrieve-a-merge-request-note "Permalink")
Retrieves a specified note for a merge request.
```
GET /projects/:id/merge_requests/:merge_request_iid/notes/:note_id
```

Parameters:
Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | yes | The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths)
`merge_request_iid` | integer | yes | The IID of a project merge request
`note_id` | integer | yes | The ID of a merge request note
json
```
{
  "id": 301,
  "body": "Comment for MR",
  "author": {
    "id": 1,
    "username": "pipin",
    "email": "admin@example.com",
    "name": "Pip",
    "state": "active",
    "created_at": "2013-09-30T13:46:01Z"
  },
  "created_at": "2013-10-02T08:57:14Z",
  "updated_at": "2013-10-02T08:57:14Z",
  "system": false,
  "noteable_id": 2,
  "noteable_type": "MergeRequest",
  "project_id": 5,
  "noteable_iid": 2,
  "resolvable": false,
  "confidential": false,
  "internal": false
}
```

shell
```
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/notes/1"
```

### Create a merge request note[](https://docs.gitlab.com/api/notes/#create-a-merge-request-note "Permalink")
Creates a note for a specified merge request. Notes are not attached to specific lines in a merge request. For other approaches with more granular control, see [Post comment to commit](https://docs.gitlab.com/api/commits/#post-comment-to-commit) in the Commits API, and [Create a new thread in the merge request diff](https://docs.gitlab.com/api/discussions/#create-a-new-thread-in-the-merge-request-diff) in the Discussions API.
If you create a note where the body only contains an emoji reaction, GitLab returns this object.
```
POST /projects/:id/merge_requests/:merge_request_iid/notes
```

Parameters:
Attribute | Type | Required | Description
---|---|---|---
`body` | string | yes | The content of a note. Limited to 1,000,000 characters.
`id` | integer or string | yes | The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths)
`merge_request_iid` | integer | yes | The IID of a project merge request
`created_at` | string | no | Date time string, ISO 8601 formatted. Example: `2016-03-11T03:45:40Z` (requires administrator or project/group owner rights)
`internal` | boolean | no | The internal flag of a note. Default is false.
`merge_request_diff_head_sha` | string | no | Required for the [`/merge` quick action](https://docs.gitlab.com/user/project/quick_actions/#merge). The SHA of the head commit, which ensures the merge request wasn’t updated after the API request was sent.
shell
```
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/notes?body=note"
```

### Update a merge request note[](https://docs.gitlab.com/api/notes/#update-a-merge-request-note "Permalink")
Updates a specified note of a merge request.
```
PUT /projects/:id/merge_requests/:merge_request_iid/notes/:note_id
```

Parameters:
Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | yes | The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths)
`merge_request_iid` | integer | yes | The IID of a project merge request
`note_id` | integer | no | The ID of a note
`body` | string | yes | The content of a note. Limited to 1,000,000 characters.
`confidential` | boolean | no |  **Deprecated** : Scheduled to be removed in GitLab 16.0. The confidential flag of a note. Default is false.
shell
```
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/notes/1?body=note"
```

### Delete a merge request note[](https://docs.gitlab.com/api/notes/#delete-a-merge-request-note "Permalink")
Deletes an existing note of a merge request.
```
DELETE /projects/:id/merge_requests/:merge_request_iid/notes/:note_id
```

Parameters:
Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | yes | The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths)
`merge_request_iid` | integer | yes | The IID of a merge request
`note_id` | integer | yes | The ID of a note
shell
```
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/merge_requests/7/notes/1602"
```

## Epics[](https://docs.gitlab.com/api/notes/#epics "Permalink")
  * Tier: Premium, Ultimate
  * Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated


The Epics REST API was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/460668) in GitLab 17.0 and is planned for removal in v5 of the API. From GitLab 17.4 to 18.0, if [the new look for epics](https://docs.gitlab.com/user/group/epics/#epics-as-work-items) is enabled, and in GitLab 18.1 and later, use the Work Items API instead. For more information, see [migrate epic APIs to work items](https://docs.gitlab.com/api/graphql/epic_work_items_api_migration_guide/). This change is a breaking change.
### List all epic notes[](https://docs.gitlab.com/api/notes/#list-all-epic-notes "Permalink")
Lists all notes for a specified epic. Epic notes are comments users can post to an epic.
The epics notes API uses the epic ID instead of epic IID. If you use the epic’s IID, GitLab returns either a 404 error or notes for the wrong epic. It’s different from the [issue notes API](https://docs.gitlab.com/api/notes/#issues) and [merge requests notes API](https://docs.gitlab.com/api/notes/#merge-requests).
```
GET /groups/:id/epics/:epic_id/notes
GET /groups/:id/epics/:epic_id/notes?sort=asc&order_by=updated_at
```

Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | yes | The ID or [URL-encoded path](https://docs.gitlab.com/api/rest/#namespaced-paths) of the group
`epic_id` | integer | yes | The ID of a group epic
`sort` | string | no | Return epic notes sorted in `asc` or `desc` order. Default is `desc`
`order_by` | string | no | Return epic notes ordered by `created_at` or `updated_at` fields. Default is `created_at`
shell
```
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/epics/11/notes"
```

### Retrieve an epic note[](https://docs.gitlab.com/api/notes/#retrieve-an-epic-note "Permalink")
Retrieves a specified note for an epic.
```
GET /groups/:id/epics/:epic_id/notes/:note_id
```

Parameters:
Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | yes | The ID or [URL-encoded path](https://docs.gitlab.com/api/rest/#namespaced-paths) of the group
`epic_id` | integer | yes | The ID of an epic
`note_id` | integer | yes | The ID of a note
json
```
{
  "id": 302,
  "body": "Epic note",
  "author": {
    "id": 1,
    "username": "pipin",
    "email": "admin@example.com",
    "name": "Pip",
    "state": "active",
    "created_at": "2013-09-30T13:46:01Z"
  },
  "created_at": "2013-10-02T09:22:45Z",
  "updated_at": "2013-10-02T10:22:45Z",
  "system": true,
  "noteable_id": 11,
  "noteable_type": "Epic",
  "project_id": 5,
  "noteable_iid": 11,
  "resolvable": false,
  "confidential": false,
  "internal": false,
  "imported": false,
  "imported_from": "none"
}
```

shell
```
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/epics/11/notes/1"
```

### Create an epic note[](https://docs.gitlab.com/api/notes/#create-an-epic-note "Permalink")
Creates a note for a specified epic. Epic notes are comments users can post to an epic. If you create a note where the body only contains an emoji reaction, GitLab returns this object.
```
POST /groups/:id/epics/:epic_id/notes
```

Parameters:
Attribute | Type | Required | Description
---|---|---|---
`body` | string | yes | The content of a note. Limited to 1,000,000 characters.
`epic_id` | integer | yes | The ID of an epic
`id` | integer or string | yes | The ID or [URL-encoded path](https://docs.gitlab.com/api/rest/#namespaced-paths) of the group
`confidential` | boolean | no |  **Deprecated** : Scheduled to be removed in GitLab 16.0 and is renamed to `internal`. The confidential flag of a note. Default is `false`.
`internal` | boolean | no | The internal flag of a note. Overrides `confidential` when both parameters are submitted. Default is `false`.
shell
```
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/epics/11/notes?body=note"
```

### Update an epic note[](https://docs.gitlab.com/api/notes/#update-an-epic-note "Permalink")
Updates a specified note of an epic.
```
PUT /groups/:id/epics/:epic_id/notes/:note_id
```

Parameters:
Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | yes | The ID or [URL-encoded path](https://docs.gitlab.com/api/rest/#namespaced-paths) of the group
`epic_id` | integer | yes | The ID of an epic
`note_id` | integer | yes | The ID of a note
`body` | string | yes | The content of a note. Limited to 1,000,000 characters.
`confidential` | boolean | no |  **Deprecated** : Scheduled to be removed in GitLab 16.0. The confidential flag of a note. Default is false.
shell
```
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/epics/11/notes/1?body=note"
```

### Delete an epic note[](https://docs.gitlab.com/api/notes/#delete-an-epic-note "Permalink")
Deletes an existing note of an epic.
```
DELETE /groups/:id/epics/:epic_id/notes/:note_id
```

Parameters:
Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | yes | The ID or [URL-encoded path](https://docs.gitlab.com/api/rest/#namespaced-paths) of the group
`epic_id` | integer | yes | The ID of an epic
`note_id` | integer | yes | The ID of a note
shell
```
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/epics/52/notes/1659"
```

## Project wikis[](https://docs.gitlab.com/api/notes/#project-wikis "Permalink")
### List all project wiki notes[](https://docs.gitlab.com/api/notes/#list-all-project-wiki-notes "Permalink")
Lists all notes for a specified project wiki page. Project wiki notes are comments users can post to a wiki page.
The wiki page notes API uses the wiki page meta ID instead of wiki page slug. If you use the page’s slug, GitLab returns a 404 error. You can retrieve the meta ID from the [project wikis API](https://docs.gitlab.com/api/wikis/).
```
GET /projects/:id/wiki_pages/:wiki_page_meta_id/notes
GET /projects/:id/wiki_pages/:wiki_page_meta_id/notes?sort=asc&order_by=updated_at
```

Parameters:
Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | yes | The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths)
`wiki_page_meta_id` | integer | yes | The ID of a wiki page meta
`sort` | string | no | Return wiki page notes sorted in `asc` or `desc` order. Default is `desc`
`order_by` | string | no | Return wiki page notes ordered by `created_at` or `updated_at` fields. Default is `created_at`
shell
```
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/wiki_pages/35/notes"
```

### Retrieve a wiki page note[](https://docs.gitlab.com/api/notes/#retrieve-a-wiki-page-note "Permalink")
Retrieves a single note for a specified wiki page.
```
GET /projects/:id/wiki_pages/:wiki_page_meta_id/notes/:note_id
```

Parameters:
Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | yes | The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths)
`wiki_page_meta_id` | integer | yes | The ID of a wiki page meta
`note_id` | integer | yes | The ID of a note
json
```
{
  "author": {
      "id": 1,
      "username": "pipin",
      "email": "admin@example.com",
      "name": "Pip",
      "state": "active",
      "created_at": "2013-09-30T13:46:01Z"
  },
  "body": "foobar",
  "commands_changes": {},
  "confidential": false,
  "created_at": "2025-03-11T11:36:32.222Z",
  "id": 1218,
  "imported": false,
  "imported_from": "none",
  "internal": false,
  "noteable_id": 35,
  "noteable_iid": null,
  "noteable_type": "WikiPage::Meta",
  "project_id": 5,
  "resolvable": false,
  "system": false,
  "type": null,
  "updated_at": "2025-03-11T11:36:32.222Z"
}
```

shell
```
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/wiki_pages/35/notes/1218"
```

### Create a wiki page note[](https://docs.gitlab.com/api/notes/#create-a-wiki-page-note "Permalink")
Creates a new note for a single wiki page. Wiki page notes are comments users can post to a wiki page.
```
POST /projects/:id/wiki_pages/:wiki_page_meta_id/notes
```

Parameters:
Attribute | Type | Required | Description
---|---|---|---
`body` | string | yes | The content of a note. Limited to 1,000,000 characters.
`wiki_page_meta_id` | integer | yes | The ID of a wiki page meta
`id` | integer or string | yes | The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths)
shell
```
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/wiki_pages/35/notes?body=note"
```

### Update a wiki page note[](https://docs.gitlab.com/api/notes/#update-a-wiki-page-note "Permalink")
Updates an existing note on a wiki page.
```
PUT /projects/:id/wiki_pages/:wiki_page_meta_id/notes/:note_id
```

Parameters:
Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | yes | The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths)
`wiki_page_meta_id` | integer | yes | The ID of a wiki page meta
`note_id` | integer | yes | The ID of a note
`body` | string | yes | The content of a note. Limited to 1,000,000 characters.
shell
```
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/wiki_pages/35/notes/1218?body=note"
```

### Delete a wiki page note[](https://docs.gitlab.com/api/notes/#delete-a-wiki-page-note "Permalink")
Deletes a note from a wiki page.
```
DELETE /projects/:id/wiki_pages/:wiki_page_meta_id/notes/:note_id
```

Parameters:
Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | yes | The ID or [URL-encoded path of the project](https://docs.gitlab.com/api/rest/#namespaced-paths)
`wiki_page_meta_id` | integer | yes | The ID of a wiki page meta
`note_id` | integer | yes | The ID of a note
shell
```
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/wiki_pages/35/notes/1218"
```

## Group wikis[](https://docs.gitlab.com/api/notes/#group-wikis "Permalink")
  * Tier: Premium, Ultimate
  * Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated


### List group wiki notes[](https://docs.gitlab.com/api/notes/#list-group-wiki-notes "Permalink")
Lists all notes for a specified group wiki page. Group wiki notes are comments users can post to a wiki page.
The wiki page notes API uses the wiki page meta ID instead of wiki page slug. If you use the page’s slug, GitLab returns a 404 error. You can retrieve the meta ID from the [group wikis API](https://docs.gitlab.com/api/group_wikis/).
```
GET /groups/:id/wiki_pages/:wiki_page_meta_id/notes
GET /groups/:id/wiki_pages/:wiki_page_meta_id/notes?sort=asc&order_by=updated_at
```

Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | yes | The ID or [URL-encoded path](https://docs.gitlab.com/api/rest/#namespaced-paths) of the group
`wiki_page_meta_id` | integer | yes | The ID of a wiki page meta
`sort` | string | no | Return wiki page notes sorted in `asc` or `desc` order. Default is `desc`
`order_by` | string | no | Return wiki page notes ordered by `created_at` or `updated_at` fields. Default is `created_at`
shell
```
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/wiki_pages/35/notes"
```

### Retrieve a wiki page note[](https://docs.gitlab.com/api/notes/#retrieve-a-wiki-page-note-1 "Permalink")
Retrieves a specified note for a wiki page.
```
GET /groups/:id/wiki_pages/:wiki_page_meta_id/notes/:note_id
```

Parameters:
Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | yes | The ID or [URL-encoded path](https://docs.gitlab.com/api/rest/#namespaced-paths) of the group
`wiki_page_meta_id` | integer | yes | The ID of a wiki page meta
`note_id` | integer | yes | The ID of a note
json
```
{
  "author": {
      "id": 1,
      "username": "pipin",
      "email": "admin@example.com",
      "name": "Pip",
      "state": "active",
      "created_at": "2013-09-30T13:46:01Z"
  },
  "body": "foobar",
  "commands_changes": {},
  "confidential": false,
  "created_at": "2025-03-11T11:36:32.222Z",
  "id": 1218,
  "imported": false,
  "imported_from": "none",
  "internal": false,
  "noteable_id": 35,
  "noteable_iid": null,
  "noteable_type": "WikiPage::Meta",
  "project_id": null,
  "resolvable": false,
  "system": false,
  "type": null,
  "updated_at": "2025-03-11T11:36:32.222Z"
}
```

shell
```
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/wiki_pages/35/notes/1218"
```

### Create a wiki page note[](https://docs.gitlab.com/api/notes/#create-a-wiki-page-note-1 "Permalink")
Creates a note for a specified wiki page. Wiki page notes are comments users can post to a wiki page.
```
POST /groups/:id/wiki_pages/:wiki_page_meta_id/notes
```

Parameters:
Attribute | Type | Required | Description
---|---|---|---
`body` | string | yes | The content of a note. Limited to 1,000,000 characters.
`wiki_page_meta_id` | integer | yes | The ID of a wiki page meta
`id` | integer or string | yes | The ID or [URL-encoded path](https://docs.gitlab.com/api/rest/#namespaced-paths) of the group
shell
```
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/wiki_pages/35/notes?body=note"
```

### Update a wiki page note[](https://docs.gitlab.com/api/notes/#update-a-wiki-page-note-1 "Permalink")
Updates a specified note on a wiki page.
```
PUT /groups/:id/wiki_pages/:wiki_page_meta_id/notes/:note_id
```

Parameters:
Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | yes | The ID or [URL-encoded path](https://docs.gitlab.com/api/rest/#namespaced-paths) of the group
`wiki_page_meta_id` | integer | yes | The ID of a wiki page meta
`note_id` | integer | yes | The ID of a note
`body` | string | yes | The content of a note. Limited to 1,000,000 characters.
shell
```
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/wiki_pages/35/notes/1218?body=note"
```

### Delete a wiki page note[](https://docs.gitlab.com/api/notes/#delete-a-wiki-page-note-1 "Permalink")
Deletes a note from a wiki page.
```
DELETE /groups/:id/wiki_pages/:wiki_page_meta_id/notes/:note_id
```

Parameters:
Attribute | Type | Required | Description
---|---|---|---
`id` | integer or string | yes | The ID or [URL-encoded path](https://docs.gitlab.com/api/rest/#namespaced-paths) of the group
`wiki_page_meta_id` | integer | yes | The ID of a wiki page meta
`note_id` | integer | yes | The ID of a note
shell
```
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/wiki_pages/35/notes/1218"
```

Was this page helpful?YesNo
Edit this page
  *     * [ Open in Web IDE`.`Quickly and easily edit multiple files. ](https://gitlab.com/-/ide/project/gitlab-org/gitlab/edit/master/-/doc/api/notes.md)
    * [ View page sourceEdit this file only. ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/api/notes.md)
    * [ Create an issueSuggest improvements. ](https://gitlab.com/gitlab-org/gitlab/-/issues/new?issuable_template=Documentation)


  * [Resource events](https://docs.gitlab.com/api/notes/#resource-events)
  * [Notes pagination](https://docs.gitlab.com/api/notes/#notes-pagination)
  * [Rate limits](https://docs.gitlab.com/api/notes/#rate-limits)
  * [Issues](https://docs.gitlab.com/api/notes/#issues)
  * [List all issue notes](https://docs.gitlab.com/api/notes/#list-all-issue-notes)
  * [Retrieve an issue note](https://docs.gitlab.com/api/notes/#retrieve-an-issue-note)
  * [Create an issue note](https://docs.gitlab.com/api/notes/#create-an-issue-note)
  * [Update an issue note](https://docs.gitlab.com/api/notes/#update-an-issue-note)
  * [Delete an issue note](https://docs.gitlab.com/api/notes/#delete-an-issue-note)
  * [Snippets](https://docs.gitlab.com/api/notes/#snippets)
  * [List all snippet notes](https://docs.gitlab.com/api/notes/#list-all-snippet-notes)
  * [Retrieve a snippet note](https://docs.gitlab.com/api/notes/#retrieve-a-snippet-note)
  * [Create a snippet note](https://docs.gitlab.com/api/notes/#create-a-snippet-note)
  * [Update a snippet note](https://docs.gitlab.com/api/notes/#update-a-snippet-note)
  * [Delete a snippet note](https://docs.gitlab.com/api/notes/#delete-a-snippet-note)
  * [Merge requests](https://docs.gitlab.com/api/notes/#merge-requests)
  * [List all merge request notes](https://docs.gitlab.com/api/notes/#list-all-merge-request-notes)
  * [Retrieve a merge request note](https://docs.gitlab.com/api/notes/#retrieve-a-merge-request-note)
  * [Create a merge request note](https://docs.gitlab.com/api/notes/#create-a-merge-request-note)
  * [Update a merge request note](https://docs.gitlab.com/api/notes/#update-a-merge-request-note)
  * [Delete a merge request note](https://docs.gitlab.com/api/notes/#delete-a-merge-request-note)
  * [Epics](https://docs.gitlab.com/api/notes/#epics)
  * [List all epic notes](https://docs.gitlab.com/api/notes/#list-all-epic-notes)
  * [Retrieve an epic note](https://docs.gitlab.com/api/notes/#retrieve-an-epic-note)
  * [Create an epic note](https://docs.gitlab.com/api/notes/#create-an-epic-note)
  * [Update an epic note](https://docs.gitlab.com/api/notes/#update-an-epic-note)
  * [Delete an epic note](https://docs.gitlab.com/api/notes/#delete-an-epic-note)
  * [Project wikis](https://docs.gitlab.com/api/notes/#project-wikis)
  * [List all project wiki notes](https://docs.gitlab.com/api/notes/#list-all-project-wiki-notes)
  * [Retrieve a wiki page note](https://docs.gitlab.com/api/notes/#retrieve-a-wiki-page-note)
  * [Create a wiki page note](https://docs.gitlab.com/api/notes/#create-a-wiki-page-note)
  * [Update a wiki page note](https://docs.gitlab.com/api/notes/#update-a-wiki-page-note)
  * [Delete a wiki page note](https://docs.gitlab.com/api/notes/#delete-a-wiki-page-note)
  * [Group wikis](https://docs.gitlab.com/api/notes/#group-wikis)
  * [List group wiki notes](https://docs.gitlab.com/api/notes/#list-group-wiki-notes)
  * [Retrieve a wiki page note](https://docs.gitlab.com/api/notes/#retrieve-a-wiki-page-note-1)
  * [Create a wiki page note](https://docs.gitlab.com/api/notes/#create-a-wiki-page-note-1)
  * [Update a wiki page note](https://docs.gitlab.com/api/notes/#update-a-wiki-page-note-1)
  * [Delete a wiki page note](https://docs.gitlab.com/api/notes/#delete-a-wiki-page-note-1)


[![GitLab Docs logo](https://docs.gitlab.com/gitlab-logo-footer.svg)](https://docs.gitlab.com/)
  * [Facebook](https://www.facebook.com/gitlab)
  * [LinkedIn](https://www.linkedin.com/company/gitlab-com)
  * [Twitter](https://twitter.com/gitlab)
  * [YouTube](https://www.youtube.com/channel/UCnMGQ8QHMAnVIsI3xJrihhg)

[![Creative Commons License](https://docs.gitlab.com/by-sa.svg)](https://creativecommons.org/licenses/by-sa/4.0/)
Company
  * [About GitLab](https://about.gitlab.com/company/)
  * [View pricing](https://about.gitlab.com/pricing/)
  * [Try GitLab for free](https://about.gitlab.com/free-trial/)


Feedback
  * [View page source](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/api/notes.md)
  * [Edit in Web IDE](https://gitlab.com/-/ide/project/gitlab-org/gitlab/edit/master/-/doc/api/notes.md)
  * [Contribute to GitLab](https://about.gitlab.com/community/contribute/)
  * [Suggest updates](https://gitlab.com/gitlab-org/gitlab/-/issues/new?issuable_template=Documentation)


Help & Community
  * [Get certified](https://university.gitlab.com/pages/certifications)
  * [Get support](https://about.gitlab.com/support/)
  * [Post on the GitLab forum](https://forum.gitlab.com/new-topic?title=topic%20title&body=topic%20body&tags=docs-feedback)


Resources
  * [Terms](https://about.gitlab.com/terms/)
  * [Privacy statement](https://about.gitlab.com/privacy/)
  * [Use of generative AI](https://docs.gitlab.com/legal/use_generative_ai/)
  * [Acceptable use of user licenses](https://docs.gitlab.com/legal/licensing_policy/)
  * Cookie Preferences


![](https://cdn.bizible.com/ipv?_biz_r=&_biz_h=800054037&_biz_u=10503924d6784ad3f2d352558587a67a&_biz_l=https%3A%2F%2Fdocs.gitlab.com%2Fapi%2Fmilestones%2F&_biz_t=1772174335855&_biz_i=Project%20milestones%20API%20%7C%20GitLab%20Docs&_biz_n=97&rnd=306290&cdn_o=a&_biz_z=1772174336229)![](https://cdn.bizible.com/ipv?_biz_r=&_biz_h=800054037&_biz_u=10503924d6784ad3f2d352558587a67a&_biz_l=https%3A%2F%2Fdocs.gitlab.com%2Fapi%2Fnotes%2F&_biz_t=1772174336228&_biz_i=Notes%20API%20%7C%20GitLab%20Docs&_biz_n=98&rnd=194904&cdn_o=a&_biz_z=1772174336230)
![Company Logo](https://cdn.cookielaw.org/logos/aa14a5c8-79e3-442a-8177-464ad850b19d/e46c1d0d-1f66-481f-bc06-5427671431da/253e6fee-c4c0-4b60-bc35-79cdae5dda32/gitlab-logo-100.png)
## Privacy Preference Center
## Privacy Preference Center
  * ### Your Privacy
  * ### Strictly Necessary Cookies
  * ### Functionality Cookies
  * ### Performance and Analytics Cookies
  * ### Targeting and Advertising Cookies
  * ### Ad User Data
  * ### Ad Personalization


#### Your Privacy
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
[Cookie Policy](https://about.gitlab.com/privacy/cookies/)
**User ID:** 42fad8d5-ed56-4786-8d74-3c72635252d2
_This User ID will be used as a unique identifier while storing and accessing your preferences for future._
**Timestamp:** --
#### Strictly Necessary Cookies
Always Active
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, enabling you to securely log into the site, filling in forms, or using the customer checkout. GitLab processes any personal data collected through these cookies on the basis of our legitimate interest.
Cookies Details
#### Functionality Cookies
Functionality Cookies
These cookies enable helpful but non-essential website functions that improve your website experience. By recognizing you when you return to our website, they may, for example, allow us to personalize our content for you or remember your preferences. If you do not allow these cookies then some or all of these services may not function properly. GitLab processes any personal data collected through these cookies on the basis of your consent
Cookies Details
#### Performance and Analytics Cookies
Performance and Analytics Cookies
These cookies allow us and our third-party service providers to recognize and count the number of visitors on our websites and to see how visitors move around our websites when they are using it. This helps us improve our products and ensures that users can easily find what they need on our websites. These cookies usually generate aggregate statistics that are not associated with an individual. To the extent any personal data is collected through these cookies, GitLab processes that data on the basis of your consent.
Cookies Details
#### Targeting and Advertising Cookies
Targeting and Advertising Cookies
These cookies enable different advertising related functions. They may allow us to record information about your visit to our websites, such as pages visited, links followed, and videos viewed so we can make our websites and the advertising displayed on it more relevant to your interests. They may be set through our website by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant advertisements on other websites. GitLab processes any personal data collected through these cookies on the basis of your consent.
Cookies Details
#### Ad User Data
Ad User Data
Sets consent for sending user data to Google for advertising purposes.
Cookies Details
#### Ad Personalization
Ad Personalization
Sets consent for personalized advertising.
Cookies Details
Back Button
### Cookie List
Filter Button
Consent Leg.Interest
checkbox label label
checkbox label label
checkbox label label
Clear
  * checkbox label label


Apply Cancel
Confirm My Choices
Allow All
[![Powered by Onetrust](https://cdn.cookielaw.org/logos/static/powered_by_logo.svg)](https://www.onetrust.com/products/cookie-consent/)
