Discussions API

  • Tier: Free, Premium, Ultimate
  • Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

Discussions are attached to:

  • Snippets
  • Issues
  • Epics
  • Merge requests
  • Commits

This includes comments, threads, and system notes. System notes are notes about changes to the object (for example, when a milestone changes).

Label notes are not part of this API, but recorded as separate events in resource label events.

Understand note types in the API

Not all discussion types are equally available in the API:

  • Note: A comment left on the root of an issue, merge request, commit, or snippet.
  • Discussion: A collection, often called a thread, of DiscussionNotes in an issue, merge request, commit, or snippet.
  • DiscussionNote: An individual item in a discussion on an issue, merge request, commit, or snippet. Items of type DiscussionNote are not returned as part of the Note API. Not available in the Events API.

Discussions pagination

By default, GET requests return 20 results at a time because the API results are paginated.

Read more on pagination.

Issues

List project issue discussion items

Gets a list of all discussion items for a single issue.

Copy to clipboard
GET /projects/:id/issues/:issue_iid/discussions
AttributeTypeRequiredDescription
idinteger/stringyesThe ID or URL-encoded path of the project.
issue_iidintegeryesThe IID of an issue.
Copy to clipboard
[
  {
    "id": "6a9c1750b37d513a43987b574953fceb50b03ce7",
    "individual_note": false,
    "notes": [
      {
        "id": 1126,
        "type": "DiscussionNote",
        "body": "discussion text",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-03T21:54:39.668Z",
        "updated_at": "2018-03-03T21:54:39.668Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "Issue",
        "project_id": 5,
        "noteable_iid": null
      },
      {
        "id": 1129,
        "type": "DiscussionNote",
        "body": "reply to the discussion",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-04T13:38:02.127Z",
        "updated_at": "2018-03-04T13:38:02.127Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "Issue",
        "project_id": 5,
        "noteable_iid": null,
        "resolvable": false
      }
    ]
  },
  {
    "id": "87805b7c09016a7058e91bdbe7b29d1f284a39e6",
    "individual_note": true,
    "notes": [
      {
        "id": 1128,
        "type": null,
        "body": "a single comment",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-04T09:17:22.520Z",
        "updated_at": "2018-03-04T09:17:22.520Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "Issue",
        "project_id": 5,
        "noteable_iid": null,
        "resolvable": false
      }
    ]
  }
]
Copy to clipboard
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/issues/11/discussions"

Get single issue discussion item

Returns a single discussion item for a specific project issue.

Copy to clipboard
GET /projects/:id/issues/:issue_iid/discussions/:discussion_id

Parameters:

AttributeTypeRequiredDescription
idinteger or stringyesThe ID or URL-encoded path of the project.
issue_iidintegeryesThe IID of an issue.
discussion_idintegeryesThe ID of a discussion item.
Copy to clipboard
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/issues/11/discussions/<discussion_id>"

Create new issue thread

Creates a new thread to a single project issue. Similar to creating a note, but other comments (replies) can be added to it later.

Copy to clipboard
POST /projects/:id/issues/:issue_iid/discussions

Parameters:

AttributeTypeRequiredDescription
bodystringyesThe content of the thread.
idinteger or stringyesThe ID or URL-encoded path of the project.
issue_iidintegeryesThe IID of an issue.
created_atstringnoDate time string, ISO 8601 formatted, such as 2016-03-11T03:45:40Z. Requires administrator or project/group owner rights.
Copy to clipboard
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/issues/11/discussions?body=comment"

Add note to existing issue thread

Adds a new note to the thread. This can also create a thread from a single comment.

Notes can be added to other items than comments, such as system notes, making them threads.

Copy to clipboard
POST /projects/:id/issues/:issue_iid/discussions/:discussion_id/notes

Parameters:

AttributeTypeRequiredDescription
bodystringyesThe content of the note or reply.
discussion_idintegeryesThe ID of a thread.
idinteger or stringyesThe ID or URL-encoded path of the project.
issue_iidintegeryesThe IID of an issue.
note_idintegeryesThe ID of a thread note.
created_atstringnoDate time string, ISO 8601 formatted, such as 2016-03-11T03:45:40Z. Requires administrator or project/group owner rights.
Copy to clipboard
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/issues/11/discussions/<discussion_id>/notes?body=comment"

Modify existing issue thread note

Modify existing thread note of an issue.

Copy to clipboard
PUT /projects/:id/issues/:issue_iid/discussions/:discussion_id/notes/:note_id

Parameters:

AttributeTypeRequiredDescription
bodystringyesThe content of the note or reply.
discussion_idintegeryesThe ID of a thread.
idinteger or stringyesThe ID or URL-encoded path of the project.
issue_iidintegeryesThe IID of an issue.
note_idintegeryesThe ID of a thread note.
Copy to clipboard
curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/issues/11/discussions/<discussion_id>/notes/1108?body=comment"

Delete an issue thread note

Deletes an existing thread note of an issue.

Copy to clipboard
DELETE /projects/:id/issues/:issue_iid/discussions/:discussion_id/notes/:note_id

Parameters:

AttributeTypeRequiredDescription
discussion_idintegeryesThe ID of a discussion.
idinteger or stringyesThe ID or URL-encoded path of the project.
issue_iidintegeryesThe IID of an issue.
note_idintegeryesThe ID of a discussion note.
Copy to clipboard
curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/issues/11/discussions/636"

Snippets

List project snippet discussion items

Gets a list of all discussion items for a single snippet.

Copy to clipboard
GET /projects/:id/snippets/:snippet_id/discussions
AttributeTypeRequiredDescription
idinteger/stringyesThe ID or URL-encoded path of the project.
snippet_idintegeryesThe ID of an snippet.
Copy to clipboard
[
  {
    "id": "6a9c1750b37d513a43987b574953fceb50b03ce7",
    "individual_note": false,
    "notes": [
      {
        "id": 1126,
        "type": "DiscussionNote",
        "body": "discussion text",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-03T21:54:39.668Z",
        "updated_at": "2018-03-03T21:54:39.668Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "Snippet",
        "project_id": 5,
        "noteable_iid": null
      },
      {
        "id": 1129,
        "type": "DiscussionNote",
        "body": "reply to the discussion",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-04T13:38:02.127Z",
        "updated_at": "2018-03-04T13:38:02.127Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "Snippet",
        "project_id": 5,
        "noteable_iid": null,
        "resolvable": false
      }
    ]
  },
  {
    "id": "87805b7c09016a7058e91bdbe7b29d1f284a39e6",
    "individual_note": true,
    "notes": [
      {
        "id": 1128,
        "type": null,
        "body": "a single comment",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-04T09:17:22.520Z",
        "updated_at": "2018-03-04T09:17:22.520Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "Snippet",
        "project_id": 5,
        "noteable_iid": null,
        "resolvable": false
      }
    ]
  }
]
Copy to clipboard
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/snippets/11/discussions"

Get single snippet discussion item

Returns a single discussion item for a specific project snippet.

Copy to clipboard
GET /projects/:id/snippets/:snippet_id/discussions/:discussion_id

Parameters:

AttributeTypeRequiredDescription
discussion_idintegeryesThe ID of a discussion item.
idinteger or stringyesThe ID or URL-encoded path of the project.
snippet_idintegeryesThe ID of an snippet.
Copy to clipboard
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/snippets/11/discussions/<discussion_id>"

Create new snippet thread

Creates a new thread to a single project snippet. Similar to creating a note, but other comments (replies) can be added to it later.

Copy to clipboard
POST /projects/:id/snippets/:snippet_id/discussions

Parameters:

AttributeTypeRequiredDescription
bodystringyesThe content of a discussion.
idinteger or stringyesThe ID or URL-encoded path of the project.
snippet_idintegeryesThe ID of an snippet.
created_atstringnoDate time string, ISO 8601 formatted, such as 2016-03-11T03:45:40Z. Requires administrator or project/group owner rights.
Copy to clipboard
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/snippets/11/discussions?body=comment"

Add note to existing snippet thread

Adds a new note to the thread.

Copy to clipboard
POST /projects/:id/snippets/:snippet_id/discussions/:discussion_id/notes

Parameters:

AttributeTypeRequiredDescription
bodystringyesThe content of the note or reply.
discussion_idintegeryesThe ID of a thread.
idinteger or stringyesThe ID or URL-encoded path of the project.
note_idintegeryesThe ID of a thread note.
snippet_idintegeryesThe ID of an snippet.
created_atstringnoDate time string, ISO 8601 formatted, such as 2016-03-11T03:45:40Z. Requires administrator or project/group owner rights.
Copy to clipboard
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/snippets/11/discussions/<discussion_id>/notes?body=comment"

Modify existing snippet thread note

Modify existing thread note of a snippet.

Copy to clipboard
PUT /projects/:id/snippets/:snippet_id/discussions/:discussion_id/notes/:note_id

Parameters:

AttributeTypeRequiredDescription
bodystringyesThe content of the note or reply.
discussion_idintegeryesThe ID of a thread.
idinteger or stringyesThe ID or URL-encoded path of the project.
note_idintegeryesThe ID of a thread note.
snippet_idintegeryesThe ID of an snippet.
Copy to clipboard
curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/snippets/11/discussions/<discussion_id>/notes/1108?body=comment"

Delete a snippet thread note

Deletes an existing thread note of a snippet.

Copy to clipboard
DELETE /projects/:id/snippets/:snippet_id/discussions/:discussion_id/notes/:note_id

Parameters:

AttributeTypeRequiredDescription
discussion_idintegeryesThe ID of a discussion.
idinteger or stringyesThe ID or URL-encoded path of the project.
note_idintegeryesThe ID of a discussion note.
snippet_idintegeryesThe ID of an snippet.
Copy to clipboard
curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/snippets/11/discussions/636"

Epics

  • Tier: Ultimate
  • Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

The Epics REST API was deprecated in GitLab 17.0 and is planned for removal in v5 of the API. In GitLab 17.4 or later, if your administrator enabled the new look for epics, use the Work Items API instead. For more information, see the guide how to migrate your existing APIs. This change is a breaking change.

List group epic discussion items

Gets a list of all discussion items for a single epic.

Copy to clipboard
GET /groups/:id/epics/:epic_id/discussions
AttributeTypeRequiredDescription
epic_idintegeryesThe ID of an epic.
idinteger or stringyesThe ID or URL-encoded path of the group.
Copy to clipboard
[
  {
    "id": "6a9c1750b37d513a43987b574953fceb50b03ce7",
    "individual_note": false,
    "notes": [
      {
        "id": 1126,
        "type": "DiscussionNote",
        "body": "discussion text",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-03T21:54:39.668Z",
        "updated_at": "2018-03-03T21:54:39.668Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "Epic",
        "project_id": 5,
        "noteable_iid": null,
        "resolvable": false
      },
      {
        "id": 1129,
        "type": "DiscussionNote",
        "body": "reply to the discussion",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-04T13:38:02.127Z",
        "updated_at": "2018-03-04T13:38:02.127Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "Epic",
        "project_id": 5,
        "noteable_iid": null,
        "resolvable": false
      }
    ]
  },
  {
    "id": "87805b7c09016a7058e91bdbe7b29d1f284a39e6",
    "individual_note": true,
    "notes": [
      {
        "id": 1128,
        "type": null,
        "body": "a single comment",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-04T09:17:22.520Z",
        "updated_at": "2018-03-04T09:17:22.520Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "Epic",
        "project_id": 5,
        "noteable_iid": null,
        "resolvable": false
      }
    ]
  }
]
Copy to clipboard
curl --header "PRIVATE-TOKEN: <your_access_token>"\
  --url "https://gitlab.example.com/api/v4/groups/5/epics/11/discussions"

Get single epic discussion item

Returns a single discussion item for a specific group epic.

Copy to clipboard
GET /groups/:id/epics/:epic_id/discussions/:discussion_id

Parameters:

AttributeTypeRequiredDescription
discussion_idintegeryesThe ID of a discussion item.
epic_idintegeryesThe ID of an epic.
idinteger or stringyesThe ID or URL-encoded path of the group.
Copy to clipboard
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/epics/11/discussions/<discussion_id>"

Create new epic thread

Creates a new thread to a single group epic. Similar to creating a note, but other comments (replies) can be added to it later.

Copy to clipboard
POST /groups/:id/epics/:epic_id/discussions

Parameters:

AttributeTypeRequiredDescription
bodystringyesThe content of the thread.
epic_idintegeryesThe ID of an epic.
idinteger or stringyesThe ID or URL-encoded path of the group.
created_atstringnoDate time string, ISO 8601 formatted, such as 2016-03-11T03:45:40Z. Requires administrator or project/group owner rights.
Copy to clipboard
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/epics/11/discussions?body=comment"

Add note to existing epic thread

Adds a new note to the thread. This can also create a thread from a single comment.

Copy to clipboard
POST /groups/:id/epics/:epic_id/discussions/:discussion_id/notes

Parameters:

AttributeTypeRequiredDescription
bodystringyesThe content of the note or reply.
discussion_idintegeryesThe ID of a thread.
epic_idintegeryesThe ID of an epic.
idinteger or stringyesThe ID or URL-encoded path of the group.
note_idintegeryesThe ID of a thread note.
created_atstringnoDate time string, ISO 8601 formatted, such as 2016-03-11T03:45:40Z. Requires administrator or project/group owner rights.
Copy to clipboard
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/epics/11/discussions/<discussion_id>/notes?body=comment"

Modify existing epic thread note

Modify existing thread note of an epic.

Copy to clipboard
PUT /groups/:id/epics/:epic_id/discussions/:discussion_id/notes/:note_id

Parameters:

AttributeTypeRequiredDescription
bodystringyesThe content of note or reply.
discussion_idintegeryesThe ID of a thread.
epic_idintegeryesThe ID of an epic.
idinteger/stringyesThe ID or URL-encoded path of the group.
note_idintegeryesThe ID of a thread note.
Copy to clipboard
curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/epics/11/discussions/<discussion_id>/notes/1108?body=comment"

Delete an epic thread note

Deletes an existing thread note of an epic.

Copy to clipboard
DELETE /groups/:id/epics/:epic_id/discussions/:discussion_id/notes/:note_id

Parameters:

AttributeTypeRequiredDescription
discussion_idintegeryesThe ID of a thread.
epic_idintegeryesThe ID of an epic.
idinteger or stringyesThe ID or URL-encoded path of the group.
note_idintegeryesThe ID of a thread note.
Copy to clipboard
curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/epics/11/discussions/636"

Merge requests

List project merge request discussion items

Gets a list of all discussion items for a single merge request.

Copy to clipboard
GET /projects/:id/merge_requests/:merge_request_iid/discussions
AttributeTypeRequiredDescription
idinteger or stringyesThe ID or URL-encoded path of the project.
merge_request_iidintegeryesThe IID of a merge request.
Copy to clipboard
[
  {
    "id": "6a9c1750b37d513a43987b574953fceb50b03ce7",
    "individual_note": false,
    "notes": [
      {
        "id": 1126,
        "type": "DiscussionNote",
        "body": "discussion text",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-03T21:54:39.668Z",
        "updated_at": "2018-03-03T21:54:39.668Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "MergeRequest",
        "project_id": 5,
        "noteable_iid": null,
        "resolved": false,
        "resolvable": true,
        "resolved_by": null,
        "resolved_at": null
      },
      {
        "id": 1129,
        "type": "DiscussionNote",
        "body": "reply to the discussion",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-04T13:38:02.127Z",
        "updated_at": "2018-03-04T13:38:02.127Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "MergeRequest",
        "project_id": 5,
        "noteable_iid": null,
        "resolved": false,
        "resolvable": true,
        "resolved_by": null
      }
    ]
  },
  {
    "id": "87805b7c09016a7058e91bdbe7b29d1f284a39e6",
    "individual_note": true,
    "notes": [
      {
        "id": 1128,
        "type": null,
        "body": "a single comment",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-04T09:17:22.520Z",
        "updated_at": "2018-03-04T09:17:22.520Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "MergeRequest",
        "project_id": 5,
        "noteable_iid": null,
        "resolved": false,
        "resolvable": true,
        "resolved_by": null
      }
    ]
  }
]

Diff comments also contain position:

Copy to clipboard
[
  {
    "id": "87805b7c09016a7058e91bdbe7b29d1f284a39e6",
    "individual_note": false,
    "notes": [
      {
        "id": 1128,
        "type": "DiffNote",
        "body": "diff comment",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-04T09:17:22.520Z",
        "updated_at": "2018-03-04T09:17:22.520Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "MergeRequest",
        "project_id": 5,
        "noteable_iid": null,
        "commit_id": "4803c71e6b1833ca72b8b26ef2ecd5adc8a38031",
        "position": {
          "base_sha": "b5d6e7b1613fca24d250fa8e5bc7bcc3dd6002ef",
          "start_sha": "7c9c2ead8a320fb7ba0b4e234bd9529a2614e306",
          "head_sha": "4803c71e6b1833ca72b8b26ef2ecd5adc8a38031",
          "old_path": "package.json",
          "new_path": "package.json",
          "position_type": "text",
          "old_line": 27,
          "new_line": 27,
          "line_range": {
            "start": {
              "line_code": "588440f66559714280628a4f9799f0c4eb880a4a_10_10",
              "type": "new"
            },
            "end": {
              "line_code": "588440f66559714280628a4f9799f0c4eb880a4a_11_11",
              "type": "old"
            }
          }
        },
        "resolved": false,
        "resolvable": true,
        "resolved_by": null
      }
    ]
  }
]
Copy to clipboard
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions"

Get single merge request discussion item

Returns a single discussion item for a specific project merge request.

Copy to clipboard
GET /projects/:id/merge_requests/:merge_request_iid/discussions/:discussion_id

Parameters:

AttributeTypeRequiredDescription
discussion_idstringyesThe ID of a discussion item.
idinteger or stringyesThe ID or URL-encoded path of the project.
merge_request_iidintegeryesThe IID of a merge request.
Copy to clipboard
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions/<discussion_id>"

Create new merge request thread

Creates a new thread to a single project merge request. Similar to creating a note but other comments (replies) can be added to it later. For other approaches, see Post comment to commit in the Commits API, and Create new merge request note in the Notes API.

Copy to clipboard
POST /projects/:id/merge_requests/:merge_request_iid/discussions

Parameters for all comments:

AttributeTypeRequiredDescription
bodystringyesThe content of the thread.
idinteger/stringyesThe ID or URL-encoded path of the project.
merge_request_iidintegeryesThe IID of a merge request.
position[base_sha]stringyes (if position* is supplied)Base commit SHA in the source branch.
position[head_sha]stringyes (if position* is supplied)SHA referencing HEAD of this merge request.
position[start_sha]stringyes (if position* is supplied)SHA referencing commit in target branch.
position[new_path]stringyes (if the position type is text)File path after change.
position[old_path]stringyes (if the position type is text)File path before change.
position[position_type]stringyes (if position* is supplied)Type of the position reference. Allowed values: text, image, or file. file introduced in GitLab 16.4.
commit_idstringnoSHA referencing commit to start this thread on.
created_atstringnoDate time string, ISO 8601 formatted, such as 2016-03-11T03:45:40Z. Requires administrator or project/group owner rights.
positionhashnoPosition when creating a diff note.
position[new_line]integernoFor text diff notes, the line number after change.
position[old_line]integernoFor text diff notes, the line number before change.
position[line_range]hashnoLine range for a multi-line diff note.
position[width]integernoFor image diff notes, width of the image.
position[height]integernoFor image diff notes, height of the image.
position[x]floatnoFor image diff notes, X coordinate.
position[y]floatnoFor image diff notes, Y coordinate.

Create a new thread on the overview page

Copy to clipboard
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions?body=comment"

Create a new thread in the merge request diff

  • Both position[old_path] and position[new_path] are required and must refer to the file path before and after the change.
  • To create a thread on an added line (highlighted in green in the merge request diff), use position[new_line] and don’t include position[old_line].
  • To create a thread on a removed line (highlighted in red in the merge request diff), use position[old_line] and don’t include position[new_line].
  • To create a thread on an unchanged line, include both position[new_line] and position[old_line] for the line. These positions might not be the same if earlier changes in the file changed the line number. For the discussion about a fix, see issue 32516.
  • If you specify incorrect base, head, start, or SHA parameters, you might run into the bug described in issue #296829).

To create a new thread:

  1. Get the latest merge request version:

    Copy to clipboard
    curl --header "PRIVATE-TOKEN: <your_access_token>" \
      --url "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/versions"
  2. Note the details of the latest version, which is listed first in the response array.

    Copy to clipboard
    [
      {
        "id": 164560414,
        "head_commit_sha": "f9ce7e16e56c162edbc9e480108041cf6b0291fe",
        "base_commit_sha": "5e6dffa282c5129aa67cd227a0429be21bfdaf80",
        "start_commit_sha": "5e6dffa282c5129aa67cd227a0429be21bfdaf80",
        "created_at": "2021-03-30T09:18:27.351Z",
        "merge_request_id": 93958054,
        "state": "collected",
        "real_size": "2"
      },
      "previous versions are here"
    ]
  3. Create a new diff thread. This example creates a thread on an added line:

    Copy to clipboard
    curl --request POST \
      --header "PRIVATE-TOKEN: <your_access_token>"\
      --form 'position[position_type]=text'\
      --form 'position[base_sha]=<use base_commit_sha from the versions response>'\
      --form 'position[head_sha]=<use head_commit_sha from the versions response>'\
      --form 'position[start_sha]=<use start_commit_sha from the versions response>'\
      --form 'position[new_path]=file.js'\
      --form 'position[old_path]=file.js'\
      --form 'position[new_line]=18'\
      --form 'body=test comment body'\
      --url "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions"

Parameters for multiline comments

Parameters for multiline comments only:

AttributeTypeRequiredDescription
position[line_range][end][line_code]stringyesLine code for the end line.
position[line_range][end][type]stringyesUse new for lines added by this commit, otherwise old.
position[line_range][start][line_code]stringyesLine code for the start line.
position[line_range][start][type]stringyesUse new for lines added by this commit, otherwise old.
position[line_range][end]hashnoMultiline note ending line.
position[line_range][start]hashnoMultiline note starting line.

Line code

A line code is of the form <SHA>_<old>_<new>, like this: adc83b19e793491b1c6ea0fd8b46cd9f32e292fc_5_5

  • <SHA> is the SHA1 hash of the filename.
  • <old> is the line number before the change.
  • <new> is the line number after the change.

For example, if a commit (<COMMIT_ID>) deletes line 463 in the README, you can comment on the deletion by referencing line 463 in the old file:

Copy to clipboard
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --form "note=Very clever to remove this unnecessary line!" \
  --form "path=README" \
  --form "line=463" \
  --form "line_type=old" \
  --url "https://gitlab.com/api/v4/projects/47/repository/commits/<COMMIT_ID>/comments"

If a commit (<COMMIT_ID>) adds line 157 to hello.rb, you can comment on the addition by referencing line 157 in the new file:

Copy to clipboard
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --form "note=This is brilliant!" \
  --form "path=hello.rb" \
  --form "line=157" \
  --form "line_type=new" \
  --url "https://gitlab.com/api/v4/projects/47/repository/commits/<COMMIT_ID>/comments"

Resolve a merge request thread

Resolve or unresolve a thread of discussion in a merge request.

Prerequisites:

  • You must have at least the Developer role, or be the author of the change being reviewed.
Copy to clipboard
PUT /projects/:id/merge_requests/:merge_request_iid/discussions/:discussion_id

Parameters:

AttributeTypeRequiredDescription
idinteger/stringyesThe ID or URL-encoded path of the project.
discussion_idstringyesThe ID of a thread.
merge_request_iidintegeryesThe IID of a merge request.
resolvedbooleanyesResolve or unresolve the discussion.
Copy to clipboard
curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions/<discussion_id>?resolved=true"

Add note to existing merge request thread

Adds a new note to the thread. This can also create a thread from a single comment.

Copy to clipboard
POST /projects/:id/merge_requests/:merge_request_iid/discussions/:discussion_id/notes

Parameters:

AttributeTypeRequiredDescription
bodystringyesThe content of the note or reply.
idinteger/stringyesThe ID or URL-encoded path of the project.
discussion_idstringyesThe ID of a thread.
merge_request_iidintegeryesThe IID of a merge request.
note_idintegeryesThe ID of a thread note.
created_atstringnoDate time string, ISO 8601 formatted, such as 2016-03-11T03:45:40Z. Requires administrator or project/group owner rights.
Copy to clipboard
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions/<discussion_id>/notes?body=comment"

Modify an existing merge request thread note

Modify or resolve an existing thread note of a merge request.

Copy to clipboard
PUT /projects/:id/merge_requests/:merge_request_iid/discussions/:discussion_id/notes/:note_id

Parameters:

AttributeTypeRequiredDescription
discussion_idstringyesThe ID of a thread.
idinteger or stringyesThe ID or URL-encoded path of the project.
merge_request_iidintegeryesThe IID of a merge request.
note_idintegeryesThe ID of a thread note.
bodystringnoThe content of the note or reply. Exactly one of body or resolved must be set.
resolvedbooleannoResolve or unresolve the note. Exactly one of body or resolved must be set.
Copy to clipboard
curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions/<discussion_id>/notes/1108?body=comment"

Resolving a note:

Copy to clipboard
curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions/<discussion_id>/notes/1108?resolved=true"

Delete a merge request thread note

Deletes an existing thread note of a merge request.

Copy to clipboard
DELETE /projects/:id/merge_requests/:merge_request_iid/discussions/:discussion_id/notes/:note_id

Parameters:

AttributeTypeRequiredDescription
discussion_idstringyesThe ID of a thread.
idinteger or stringyesThe ID or URL-encoded path of the project.
merge_request_iidintegeryesThe IID of a merge request.
note_idintegeryesThe ID of a thread note.
Copy to clipboard
curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions/636"

Commits

List project commit discussion items

Gets a list of all discussion items for a single commit.

Copy to clipboard
GET /projects/:id/repository/commits/:commit_id/discussions
AttributeTypeRequiredDescription
commit_idstringyesThe SHA of a commit.
idinteger or stringyesThe ID or URL-encoded path of the project.
Copy to clipboard
[
  {
    "id": "6a9c1750b37d513a43987b574953fceb50b03ce7",
    "individual_note": false,
    "notes": [
      {
        "id": 1126,
        "type": "DiscussionNote",
        "body": "discussion text",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-03T21:54:39.668Z",
        "updated_at": "2018-03-03T21:54:39.668Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "Commit",
        "project_id": 5,
        "noteable_iid": null,
        "resolvable": false
      },
      {
        "id": 1129,
        "type": "DiscussionNote",
        "body": "reply to the discussion",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-04T13:38:02.127Z",
        "updated_at": "2018-03-04T13:38:02.127Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "Commit",
        "project_id": 5,
        "noteable_iid": null,
        "resolvable": false
      }
    ]
  },
  {
    "id": "87805b7c09016a7058e91bdbe7b29d1f284a39e6",
    "individual_note": true,
    "notes": [
      {
        "id": 1128,
        "type": null,
        "body": "a single comment",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-04T09:17:22.520Z",
        "updated_at": "2018-03-04T09:17:22.520Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "Commit",
        "project_id": 5,
        "noteable_iid": null,
        "resolvable": false
      }
    ]
  }
]

Diff comments contain also position:

Copy to clipboard
[
  {
    "id": "87805b7c09016a7058e91bdbe7b29d1f284a39e6",
    "individual_note": false,
    "notes": [
      {
        "id": 1128,
        "type": "DiffNote",
        "body": "diff comment",
        "attachment": null,
        "author": {
          "id": 1,
          "name": "root",
          "username": "root",
          "state": "active",
          "avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
          "web_url": "http://localhost:3000/root"
        },
        "created_at": "2018-03-04T09:17:22.520Z",
        "updated_at": "2018-03-04T09:17:22.520Z",
        "system": false,
        "noteable_id": 3,
        "noteable_type": "Commit",
        "project_id": 5,
        "noteable_iid": null,
        "position": {
          "base_sha": "b5d6e7b1613fca24d250fa8e5bc7bcc3dd6002ef",
          "start_sha": "7c9c2ead8a320fb7ba0b4e234bd9529a2614e306",
          "head_sha": "4803c71e6b1833ca72b8b26ef2ecd5adc8a38031",
          "old_path": "package.json",
          "new_path": "package.json",
          "position_type": "text",
          "old_line": 27,
          "new_line": 27
        },
        "resolvable": false
      }
    ]
  }
]
Copy to clipboard
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/repository/commits/<commit_id>/discussions"

Get single commit discussion item

Returns a single discussion item for a specific project commit

Copy to clipboard
GET /projects/:id/repository/commits/:commit_id/discussions/:discussion_id

Parameters:

AttributeTypeRequiredDescription
commit_idstringyesThe SHA of a commit.
discussion_idstringyesThe ID of a discussion item.
idinteger or stringyesThe ID or URL-encoded path of the project.
Copy to clipboard
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/repository/commits/<commit_id>/discussions/<discussion_id>"

Create new commit thread

Creates a new thread to a single project commit. Similar to creating a note but other comments (replies) can be added to it later.

Copy to clipboard
POST /projects/:id/repository/commits/:commit_id/discussions

Parameters:

AttributeTypeRequiredDescription
bodystringyesThe content of the thread.
commit_idstringyesThe SHA of a commit.
idinteger/stringyesThe ID or URL-encoded path of the project.
position[base_sha]stringyes (if position* is supplied)SHA of the parent commit.
position[head_sha]stringyes (if position* is supplied)The SHA of this commit. Same as commit_id.
position[start_sha]stringyes (if position* is supplied)SHA of the parent commit.
position[position_type]stringyes (if position* is supplied)Type of the position reference. Allowed values: text, image, or file. file introduced in GitLab 16.4.
created_atstringnoDate time string, ISO 8601 formatted, such as 2016-03-11T03:45:40Z. Requires administrator or project/group owner rights.
positionhashnoPosition when creating a diff note.

| position[new_path] | string | no | File path after change. | | position[new_line] | integer | no | Line number after change. | | position[old_path] | string | no | File path before change. | | position[old_line] | integer | no | Line number before change. | | position[height] | integer | no | For image diff notes, image height. | | position[width] | integer | no | For image diff notes, image width. | | position[x] | integer | no | For image diff notes, X coordinate. | | position[y] | integer | no | For image diff notes, Y coordinate. |

Copy to clipboard
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/repository/commits/<commit_id>/discussions?body=comment"

The rules for creating the API request are the same as when creating a new thread in the merge request diff. The exceptions:

  • base_sha
  • head_sha
  • start_sha

Add note to existing commit thread

Adds a new note to the thread.

Copy to clipboard
POST /projects/:id/repository/commits/:commit_id/discussions/:discussion_id/notes

Parameters:

AttributeTypeRequiredDescription
bodystringyesThe content of the note or reply.
commit_idstringyesThe SHA of a commit.
discussion_idstringyesThe ID of a thread.
idinteger or stringyesThe ID or URL-encoded path of the project.
note_idintegeryesThe ID of a thread note.
created_atstringnoDate time string, ISO 8601 formatted, such 2016-03-11T03:45:40Z. Requires administrator or project/group owner rights.
Copy to clipboard
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/repository/commits/<commit_id>/discussions/<discussion_id>/notes?body=comment

Modify an existing commit thread note

Modify or resolve an existing thread note of a commit.

Copy to clipboard
PUT /projects/:id/repository/commits/:commit_id/discussions/:discussion_id/notes/:note_id

Parameters:

AttributeTypeRequiredDescription
commit_idstringyesThe SHA of a commit.
discussion_idstringyesThe ID of a thread.
idinteger or stringyesThe ID or URL-encoded path of the project.
note_idintegeryesThe ID of a thread note.
bodystringnoThe content of a note.
Copy to clipboard
curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/repository/commits/<commit_id>/discussions/<discussion_id>/notes/1108?body=comment"

Resolving a note:

Copy to clipboard
curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/repository/commits/<commit_id>/discussions/<discussion_id>/notes/1108?resolved=true"

Delete a commit thread note

Deletes an existing thread note of a commit.

Copy to clipboard
DELETE /projects/:id/repository/commits/:commit_id/discussions/:discussion_id/notes/:note_id

Parameters:

AttributeTypeRequiredDescription
idinteger or stringyesThe ID or URL-encoded path of the project.
commit_idstringyesThe SHA of a commit.
discussion_idstringyesThe ID of a thread.
note_idintegeryesThe ID of a thread note.
Copy to clipboard
curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/repository/commits/<commit_id>/discussions/<discussion_id>/notes/636"