Discussions API

Discussions are a set of related notes on:

Snippets
Issues
Epics
Merge requests
Commits

This includes comments and 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.

Discussions pagination

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

Issues

List project issue discussion items

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

GET /projects/:id/issues/:issue_iid/discussions

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID or URL-encoded path of the project.
`issue_iid`	integer	yes	The IID of an issue.

[
  {
    "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
      }
    ]
  }
]

curl --header "PRIVATE-TOKEN: <your_access_token>"\
  "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.

GET /projects/:id/issues/:issue_iid/discussions/:discussion_id

Parameters:

Attribute	Type	Required	Description
`id`	integer or string	yes	The ID or URL-encoded path of the project.
`issue_iid`	integer	yes	The IID of an issue.
`discussion_id`	integer	yes	The ID of a discussion item.

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  "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.

POST /projects/:id/issues/:issue_iid/discussions

Parameters:

Attribute	Type	Required	Description
`body`	string	yes	The content of the thread.
`id`	integer or string	yes	The ID or URL-encoded path of the project.
`issue_iid`	integer	yes	The IID of an issue.
`created_at`	string	no	Date time string, ISO 8601 formatted, such as `2016-03-11T03:45:40Z`. Requires administrator or project/group owner rights.

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
  "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.

POST /projects/:id/issues/:issue_iid/discussions/:discussion_id/notes

Parameters:

Attribute	Type	Required	Description
`body`	string	yes	The content of the note or reply.
`discussion_id`	integer	yes	The ID of a thread.
`id`	integer or string	yes	The ID or URL-encoded path of the project.
`issue_iid`	integer	yes	The IID of an issue.
`note_id`	integer	yes	The ID of a thread note.
`created_at`	string	no	Date time string, ISO 8601 formatted, such as `2016-03-11T03:45:40Z`. Requires administrator or project/group owner rights.

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
  "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.

PUT /projects/:id/issues/:issue_iid/discussions/:discussion_id/notes/:note_id

Parameters:

Attribute	Type	Required	Description
`body`	string	yes	The content of the note or reply.
`discussion_id`	integer	yes	The ID of a thread.
`id`	integer or string	yes	The ID or URL-encoded path of the project.
`issue_iid`	integer	yes	The IID of an issue.
`note_id`	integer	yes	The ID of a thread note.

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
  "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.

DELETE /projects/:id/issues/:issue_iid/discussions/:discussion_id/notes/:note_id

Parameters:

Attribute	Type	Required	Description
`discussion_id`	integer	yes	The ID of a discussion.
`id`	integer or string	yes	The ID or URL-encoded path of the project.
`issue_iid`	integer	yes	The IID of an issue.
`note_id`	integer	yes	The ID of a discussion note.

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
  "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.

GET /projects/:id/snippets/:snippet_id/discussions

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID or URL-encoded path of the project.
`snippet_id`	integer	yes	The ID of an snippet.

[
  {
    "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
      }
    ]
  }
]

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  "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.

GET /projects/:id/snippets/:snippet_id/discussions/:discussion_id

Parameters:

Attribute	Type	Required	Description
`discussion_id`	integer	yes	The ID of a discussion item.
`id`	integer or string	yes	The ID or URL-encoded path of the project.
`snippet_id`	integer	yes	The ID of an snippet.

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
  "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.

POST /projects/:id/snippets/:snippet_id/discussions

Parameters:

Attribute	Type	Required	Description
`body`	string	yes	The content of a discussion.
`id`	integer or string	yes	The ID or URL-encoded path of the project.
`snippet_id`	integer	yes	The ID of an snippet.
`created_at`	string	no	Date time string, ISO 8601 formatted, such as `2016-03-11T03:45:40Z`. Requires administrator or project/group owner rights.

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>"\
  "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.

POST /projects/:id/snippets/:snippet_id/discussions/:discussion_id/notes

Parameters:

Attribute	Type	Required	Description
`body`	string	yes	The content of the note or reply.
`discussion_id`	integer	yes	The ID of a thread.
`id`	integer or string	yes	The ID or URL-encoded path of the project.
`note_id`	integer	yes	The ID of a thread note.
`snippet_id`	integer	yes	The ID of an snippet.
`created_at`	string	no	Date time string, ISO 8601 formatted, such as `2016-03-11T03:45:40Z`. Requires administrator or project/group owner rights.

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
  "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.

PUT /projects/:id/snippets/:snippet_id/discussions/:discussion_id/notes/:note_id

Parameters:

Attribute	Type	Required	Description
`body`	string	yes	The content of the note or reply.
`discussion_id`	integer	yes	The ID of a thread.
`id`	integer or string	yes	The ID or URL-encoded path of the project.
`note_id`	integer	yes	The ID of a thread note.
`snippet_id`	integer	yes	The ID of an snippet.

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
  "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.

DELETE /projects/:id/snippets/:snippet_id/discussions/:discussion_id/notes/:note_id

Parameters:

Attribute	Type	Required	Description
`discussion_id`	integer	yes	The ID of a discussion.
`id`	integer or string	yes	The ID or URL-encoded path of the project.
`note_id`	integer	yes	The ID of a discussion note.
`snippet_id`	integer	yes	The ID of an snippet.

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
  "https://gitlab.example.com/api/v4/projects/5/snippets/11/discussions/636"

Epics

List group epic discussion items

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

GET /groups/:id/epics/:epic_id/discussions

Attribute	Type	Required	Description
`epic_id`	integer	yes	The ID of an epic.
`id`	integer or string	yes	The ID or URL-encoded path of the group.

[
  {
    "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
      }
    ]
  }
]

curl --header "PRIVATE-TOKEN: <your_access_token>"\
  "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.

GET /groups/:id/epics/:epic_id/discussions/:discussion_id

Parameters:

Attribute	Type	Required	Description
`discussion_id`	integer	yes	The ID of a discussion item.
`epic_id`	integer	yes	The ID of an epic.
`id`	integer or string	yes	The ID or URL-encoded path of the group.

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
  "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.

POST /groups/:id/epics/:epic_id/discussions

Parameters:

Attribute	Type	Required	Description
`body`	string	yes	The content of the thread.
`epic_id`	integer	yes	The ID of an epic.
`id`	integer or string	yes	The ID or URL-encoded path of the group.
`created_at`	string	no	Date time string, ISO 8601 formatted, such as `2016-03-11T03:45:40Z`. Requires administrator or project/group owner rights.

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
  "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.

POST /groups/:id/epics/:epic_id/discussions/:discussion_id/notes

Parameters:

Attribute	Type	Required	Description
`body`	string	yes	The content of the note or reply.
`discussion_id`	integer	yes	The ID of a thread.
`epic_id`	integer	yes	The ID of an epic.
`id`	integer or string	yes	The ID or URL-encoded path of the group.
`note_id`	integer	yes	The ID of a thread note.
`created_at`	string	no	Date time string, ISO 8601 formatted, such as `2016-03-11T03:45:40Z`. Requires administrator or project/group owner rights.

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
  "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.

PUT /groups/:id/epics/:epic_id/discussions/:discussion_id/notes/:note_id

Parameters:

Attribute	Type	Required	Description
`body`	string	yes	The content of note or reply.
`discussion_id`	integer	yes	The ID of a thread.
`epic_id`	integer	yes	The ID of an epic.
`id`	integer/string	yes	The ID or URL-encoded path of the group.
`note_id`	integer	yes	The ID of a thread note.

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
  "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.

DELETE /groups/:id/epics/:epic_id/discussions/:discussion_id/notes/:note_id

Parameters:

Attribute	Type	Required	Description
`discussion_id`	integer	yes	The ID of a thread.
`epic_id`	integer	yes	The ID of an epic.
`id`	integer or string	yes	The ID or URL-encoded path of the group.
`note_id`	integer	yes	The ID of a thread note.

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
  "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.

GET /projects/:id/merge_requests/:merge_request_iid/discussions

Attribute	Type	Required	Description
`id`	integer or string	yes	The ID or URL-encoded path of the project.
`merge_request_iid`	integer	yes	The IID of a merge request.

[
  {
    "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": "Merge request",
        "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": "Merge request",
        "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": "Merge request",
        "project_id": 5,
        "noteable_iid": null,
        "resolved": false,
        "resolvable": true,
        "resolved_by": null
      }
    ]
  }
]

Diff comments also contain position:

[
  {
    "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": "Merge request",
        "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
      }
    ]
  }
]

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  "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.

GET /projects/:id/merge_requests/:merge_request_iid/discussions/:discussion_id

Parameters:

Attribute	Type	Required	Description
`discussion_id`	string	yes	The ID of a discussion item.
`id`	integer or string	yes	The ID or URL-encoded path of the project.
`merge_request_iid`	integer	yes	The IID of a merge request.

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions/<discussion_id>"

Create new merge request thread

The commit id entry was introduced in GitLab 13.7.

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.

POST /projects/:id/merge_requests/:merge_request_iid/discussions

Parameters for all comments:

Attribute	Type	Required	Description
`body`	string	yes	The content of the thread.
`id`	integer/string	yes	The ID or URL-encoded path of the project.
`merge_request_iid`	integer	yes	The IID of a merge request.
`position[base_sha]`	string	yes	Base commit SHA in the source branch.
`position[head_sha]`	string	yes	SHA referencing HEAD of this merge request.
`position[start_sha]`	string	yes	SHA referencing commit in target branch.
`position[new_path]`	string	yes (if the position type is `text`)	File path after change.
`position[old_path]`	string	yes (if the position type is `text`)	File path before change.
`position[position_type]`	string	yes	Type of the position reference. Allowed values: `text` or `image`.
`commit_id`	string	no	SHA referencing commit to start this thread on.
`created_at`	string	no	Date time string, ISO 8601 formatted, such as `2016-03-11T03:45:40Z`. Requires administrator or project/group owner rights.
`position`	hash	no	Position when creating a diff note.
`position[new_line]`	integer	no	For `text` diff notes, the line number after change.
`position[old_line]`	integer	no	For `text` diff notes, the line number before change.
`position[line_range]`	hash	no	Line range for a multi-line diff note.
`position[width]`	integer	no	For `image` diff notes, width of the image.
`position[height]`	integer	no	For `image` diff notes, height of the image.
`position[x]`	float	no	For `image` diff notes, X coordinate.
`position[y]`	float	no	For `image` diff notes, Y coordinate.

Create a new thread on the overview page

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
  "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:

Get the latest merge request version:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/versions"

Note the details of the latest version, which is listed first in the response array.

[
  {
    "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"
]

Create a new diff thread. This example creates a thread on an added line:

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'\
  "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions"

Parameters for multiline comments

Parameters for multiline comments only:

Attribute	Type	Required	Description
`position[line_range][end][line_code]`	string	yes	Line code for the end line.
`position[line_range][end][type]`	string	yes	Use `new` for lines added by this commit, otherwise `old`.
`position[line_range][start][line_code]`	string	yes	Line code for the start line.
`position[line_range][start][type]`	string	yes	Use `new` for lines added by this commit, otherwise `old`.
`position[line_range][end]`	hash	no	Multiline note ending line.
`position[line_range][start]`	hash	no	Multiline 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:

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" \
  "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:

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" \
  "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.

Prerequisite:

You must have at least the Developer role, or be the author of the change being reviewed.

PUT /projects/:id/merge_requests/:merge_request_iid/discussions/:discussion_id

Parameters:

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID or URL-encoded path of the project.
`discussion_id`	string	yes	The ID of a thread.
`merge_request_iid`	integer	yes	The IID of a merge request.
`resolved`	boolean	yes	Resolve or unresolve the discussion.

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
  "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.

POST /projects/:id/merge_requests/:merge_request_iid/discussions/:discussion_id/notes

Parameters:

Attribute	Type	Required	Description
`body`	string	yes	The content of the note or reply.
`id`	integer/string	yes	The ID or URL-encoded path of the project.
`discussion_id`	string	yes	The ID of a thread.
`merge_request_iid`	integer	yes	The IID of a merge request.
`note_id`	integer	yes	The ID of a thread note.
`created_at`	string	no	Date time string, ISO 8601 formatted, such as `2016-03-11T03:45:40Z`. Requires administrator or project/group owner rights.

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
  "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.

PUT /projects/:id/merge_requests/:merge_request_iid/discussions/:discussion_id/notes/:note_id

Parameters:

Attribute	Type	Required	Description
`discussion_id`	string	yes	The ID of a thread.
`id`	integer or string	yes	The ID or URL-encoded path of the project.
`merge_request_iid`	integer	yes	The IID of a merge request.
`note_id`	integer	yes	The ID of a thread note.
`body`	string	no	The content of the note or reply. Exactly one of `body` or `resolved` must be set.
`resolved`	boolean	no	Resolve or unresolve the note. Exactly one of `body` or `resolved` must be set.

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
  "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions/<discussion_id>/notes/1108?body=comment"

Resolving a note:

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
  "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.

DELETE /projects/:id/merge_requests/:merge_request_iid/discussions/:discussion_id/notes/:note_id

Parameters:

Attribute	Type	Required	Description
`discussion_id`	string	yes	The ID of a thread.
`id`	integer or string	yes	The ID or URL-encoded path of the project.
`merge_request_iid`	integer	yes	The IID of a merge request.
`note_id`	integer	yes	The ID of a thread note.

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
  "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.

GET /projects/:id/repository/commits/:commit_id/discussions

Attribute	Type	Required	Description
`commit_id`	string	yes	The SHA of a commit.
`id`	integer or string	yes	The ID or URL-encoded path of the project.

[
  {
    "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:

[
  {
    "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
      }
    ]
  }
]

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  "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

GET /projects/:id/repository/commits/:commit_id/discussions/:discussion_id

Parameters:

Attribute	Type	Required	Description
`commit_id`	string	yes	The SHA of a commit.
`discussion_id`	string	yes	The ID of a discussion item.
`id`	integer or string	yes	The ID or URL-encoded path of the project.

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  "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.

POST /projects/:id/repository/commits/:commit_id/discussions

Parameters:

Attribute	Type	Required	Description
`body`	string	yes	The content of the thread.
`commit_id`	string	yes	The SHA of a commit.
`id`	integer/string	yes	The ID or URL-encoded path of the project.
`position[base_sha]`	string	yes	SHA of the parent commit.
`position[head_sha]`	string	yes	The SHA of this commit. Same as `commit_id`.
`position[start_sha]`	string	yes	SHA of the parent commit.
`position[position_type]`	string	yes	Type of the position reference. Allowed values: `text` or `image`.
`created_at`	string	no	Date time string, ISO 8601 formatted, such as `2016-03-11T03:45:40Z`. Requires administrator or project/group owner rights.
`position`	hash	no	Position 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.

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
  "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.

POST /projects/:id/repository/commits/:commit_id/discussions/:discussion_id/notes

Parameters:

Attribute	Type	Required	Description
`body`	string	yes	The content of the note or reply.
`commit_id`	string	yes	The SHA of a commit.
`discussion_id`	string	yes	The ID of a thread.
`id`	integer or string	yes	The ID or URL-encoded path of the project.
`note_id`	integer	yes	The ID of a thread note.
`created_at`	string	no	Date time string, ISO 8601 formatted, such `2016-03-11T03:45:40Z`. Requires administrator or project/group owner rights.

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
  "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.

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

Parameters:

Attribute	Type	Required	Description
`commit_id`	string	yes	The SHA of a commit.
`discussion_id`	string	yes	The ID of a thread.
`id`	integer or string	yes	The ID or URL-encoded path of the project.
`note_id`	integer	yes	The ID of a thread note.
`body`	string	no	The content of a note.

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

Resolving a note:

curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" \
  "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.

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

Parameters:

Attribute	Type	Required	Description
`id`	integer or string	yes	The ID or URL-encoded path of the project.
`commit_id`	string	yes	The SHA of a commit.
`discussion_id`	string	yes	The ID of a thread.
`note_id`	integer	yes	The ID of a thread note.

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" \
  "https://gitlab.example.com/api/v4/projects/5/repository/commits/<commit_id>/discussions/<discussion_id>/notes/636"

Discussions API

Discussions pagination

Issues

List project issue discussion items

Get single issue discussion item

Create new issue thread

Add note to existing issue thread

Modify existing issue thread note

Delete an issue thread note

Snippets

List project snippet discussion items

Get single snippet discussion item

Create new snippet thread

Add note to existing snippet thread

Modify existing snippet thread note

Delete a snippet thread note

Epics

List group epic discussion items

Get single epic discussion item

Create new epic thread

Add note to existing epic thread

Modify existing epic thread note

Delete an epic thread note

Merge requests

List project merge request discussion items

Get single merge request discussion item

Create new merge request thread

Create a new thread on the overview page

Create a new thread in the merge request diff

Parameters for multiline comments

Line code

Resolve a merge request thread

Add note to existing merge request thread

Modify an existing merge request thread note

Delete a merge request thread note

Commits

List project commit discussion items

Get single commit discussion item

Create new commit thread

Add note to existing commit thread

Modify an existing commit thread note

Delete a commit thread note

Help & feedback

Docs

Product

Feature availability and product trials

Get Help