Discussions API - Gitlabhq

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

Use this API to manage discussions. This includes comments, threads, and system notes about changes to an object (for example, when a milestone changes).

To manage label notes, use the resource label events API.

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.

Issues

List all issue discussion items

Lists all discussion items for a specified issue in a project.

plaintext

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

Supported attributes:

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.

If successful, returns 200 OK and the following response attributes:

Attribute	Type	Description
`id`	string	The ID of the discussion.
`individual_note`	boolean	If `true`, an individual note or part of a discussion.
`notes`	array	Array of note objects in the discussion.
`notes[].id`	integer	The ID of the note.
`notes[].type`	string	The type of note (`DiscussionNote` or `null`).
`notes[].body`	string	The content of the note.
`notes[].author`	object	The author of the note.
`notes[].created_at`	string	When the note was created (ISO 8601 format).
`notes[].updated_at`	string	When the note was last updated (ISO 8601 format).
`notes[].system`	boolean	If `true`, a system note.
`notes[].noteable_id`	integer	The ID of the noteable object.
`notes[].noteable_type`	string	The type of the noteable object.
`notes[].project_id`	integer	The ID of the project.
`notes[].resolvable`	boolean	If `true`, the note can be resolved.

Example request:

shell

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

Example response:

json

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

Retrieve an issue discussion item

Retrieves a specified discussion item for a project issue.

plaintext

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

Supported attributes:

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.
`issue_iid`	integer	Yes	The IID of an issue.

If successful, returns 200 OK and the same response attributes as List issue discussion items.

Example request:

shell

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

Create an 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.

plaintext

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

Supported attributes:

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.

If successful, returns 201 Created and the same response attributes as List issue discussion items.

Example request:

shell

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

Add a note to an issue thread

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

[!note] Notes cannot be added to system notes. Attempting to do so returns a 400 Bad Request error.

plaintext

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

Supported attributes:

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.
`created_at`	string	No	Date time string, ISO 8601 formatted, such as `2016-03-11T03:45:40Z`. Requires administrator or project/group owner rights.

If successful, returns 201 Created and the created note object.

Example request:

shell

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"

Update an issue thread note

Updates an existing thread note of an issue.

plaintext

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

Supported attributes:

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.

If successful, returns 200 OK and the updated note object.

Example request:

shell

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

Delete an issue thread note

Deletes an existing thread note of an issue.

plaintext

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

Supported attributes:

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.

If successful, returns 204 No Content.

Example request:

shell

curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/5/issues/11/discussions/<discussion_id>/notes/<note_id>"

Snippets

List all snippet discussion items

Lists all discussion items for a specified snippet in a project.

plaintext

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

Supported attributes:

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

If successful, returns 200 OK and the same response attributes as List issue discussion items, with noteable_type set to Snippet.

Example request:

shell

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

Example response:

json

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

Retrieve a snippet discussion item

Retrieves a specified discussion item for a project snippet.

plaintext

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

Supported attributes:

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 a snippet.

If successful, returns 200 OK and the same response attributes as List snippet discussion items.

Example request:

shell

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

Create a 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.

plaintext

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

Supported attributes:

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 a 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.

If successful, returns 201 Created and the created discussion object.

Example request:

shell

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

Add a note to a snippet thread

Adds a new note to the thread.

plaintext

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

Supported attributes:

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.
`snippet_id`	integer	Yes	The ID of a 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.

If successful, returns 201 Created and the created note object.

Example request:

shell

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"

Update a snippet thread note

Updates an existing thread note of a snippet.

plaintext

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

Supported attributes:

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 a snippet.

If successful, returns 200 OK and the updated note object.

Example request:

shell

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

Delete a snippet thread note

Deletes an existing thread note of a snippet.

plaintext

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

Supported attributes:

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 a snippet.

If successful, returns 204 No Content.

Example request:

shell

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

Epics

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

[!warning] The Epics REST API was deprecated in GitLab 17.0 and is planned for removal in v5 of the API. This change is a breaking change.

Use the Work Items API instead:

GitLab 17.4 to 18.0: Required when the new look for epics is enabled.

GitLab 18.1 and later: Required for all installations.

For more information, see the API migration guide.

List all epic discussion items

Lists all discussion items for a single epic.

plaintext

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

Supported attributes:

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.

If successful, returns 200 OK and the same response attributes as List issue discussion items, with noteable_type set to Epic.

Example request:

shell

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

Example response:

json

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

Retrieve an epic discussion item

Retrieves a specified discussion item for a group epic.

plaintext

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

Supported attributes:

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.

If successful, returns 200 OK and the same response attributes as List epic discussion items.

Example request:

shell

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

Create an 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.

plaintext

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

Supported attributes:

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.

If successful, returns 201 Created and the created discussion object.

Example request:

shell

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

Add a note to an epic thread

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

plaintext

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

Supported attributes:

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.
`created_at`	string	No	Date time string, ISO 8601 formatted, such as `2016-03-11T03:45:40Z`. Requires administrator or project/group owner rights.

If successful, returns 201 Created and the created note object.

Example request:

shell

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"

Update an epic thread note

Updates an existing thread note of an epic.

plaintext

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

Supported attributes:

Attribute	Type	Required	Description
`body`	string	Yes	The content of a 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.

If successful, returns 200 OK and the updated note object.

Example request:

shell

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

Delete an epic thread note

Deletes an existing thread note of an epic.

plaintext

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

Supported attributes:

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.

If successful, returns 204 No Content.

Example request:

shell

curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/5/epics/11/discussions/<discussion_id>/notes/<note_id>"

Merge requests

List all merge request discussion items

Lists all discussion items for a specified merge request.

plaintext

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

Supported attributes:

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.

If successful, returns 200 OK and the following response attributes:

Attribute	Type	Description
`id`	string	The ID of the discussion.
`individual_note`	boolean	If `true`, an individual note or part of a discussion.
`notes`	array	Array of note objects in the discussion.
`notes[].id`	integer	The ID of the note.
`notes[].type`	string	The type of note (`DiscussionNote`, `DiffNote`, or `null`).
`notes[].body`	string	The content of the note.
`notes[].author`	object	The author of the note.
`notes[].created_at`	string	When the note was created (ISO 8601 format).
`notes[].updated_at`	string	When the note was last updated (ISO 8601 format).
`notes[].system`	boolean	If `true`, a system note.
`notes[].noteable_id`	integer	The ID of the noteable object.
`notes[].noteable_type`	string	The type of the noteable object.
`notes[].project_id`	integer	The ID of the project.
`notes[].resolved`	boolean	If `true`, the note is resolved (merge requests only).
`notes[].resolvable`	boolean	If `true`, the note can be resolved.
`notes[].resolved_by`	object	The user who resolved the note.
`notes[].resolved_at`	string	When the note was resolved (ISO 8601 format).
`notes[].position`	object	Position information for diff notes.
`notes[].suggestions`	array	Array of suggestion objects for the note.

Diff comments also contain position information:

Example request:

shell

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

Example response:

json

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

json

[
  {
    "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",
              "old_line": null,
              "new_line": 10
            },
            "end": {
              "line_code": "588440f66559714280628a4f9799f0c4eb880a4a_11_11",
              "type": "old",
              "old_line": 11,
              "new_line": 11
            }
          }
        },
        "resolved": false,
        "resolvable": true,
        "resolved_by": null,
        "suggestions": [
          {
            "id": 1,
            "from_line": 27,
            "to_line": 27,
            "appliable": true,
            "applied": false,
            "from_content": "x",
            "to_content": "b"
          }
        ]
      }
    ]
  }
]

Retrieve a merge request discussion item

Retrieves a specified discussion item for a project merge request.

plaintext

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

Supported attributes:

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.

If successful, returns 200 OK and the same response attributes as List merge request discussion items.

Example request:

shell

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

Create a 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 a merge request note in the Notes API.

plaintext

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

Supported attributes for all comments:

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.
`merge_request_iid`	integer	Yes	The IID of a merge request.
`commit_id`	string	No	SHA referencing commit to start this discussion 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[base_sha]`	string	Yes (if `position*` is supplied)	Base commit SHA in the source branch.
`position[head_sha]`	string	Yes (if `position*` is supplied)	SHA referencing HEAD of this merge request.
`position[start_sha]`	string	Yes (if `position*` is supplied)	SHA referencing commit in target branch.
`position[position_type]`	string	Yes (if position* is supplied)	Type of the position reference. Allowed values: `text`, `image`, or `file`. `file` introduced in GitLab 16.4.
`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[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.

If successful, returns 201 Created and the created discussion object.

Create a new thread on the overview page

shell

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:

Get the latest merge request version:

shell

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

json

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

shell

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

Supported attributes 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][end][old_line]`	integer	No	Old line number of the end line.
`position[line_range][end][new_line]`	integer	No	New line number of the end line.
`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][start][old_line]`	integer	No	Old line number of the start line.
`position[line_range][start][new_line]`	integer	No	New line number of the start line.
`position[line_range][end]`	hash	No	Multiline note ending line.
`position[line_range][start]`	hash	No	Multiline note starting line.

The old_line and new_line parameters inside the line_range attribute display the range for multi-line comments. For example, "Comment on lines +296 to +297".

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:

shell

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:

shell

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 reopen a thread of discussion in a merge request.

Prerequisites:

You must have the Developer, Maintainer, or Owner role, or be the author of the change being reviewed.

plaintext

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

Supported attributes:

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.
`resolved`	boolean	Yes	If `true`, resolve or reopen the discussion.

If successful, returns 200 OK and the updated discussion object.

Example request:

shell

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 a merge request thread

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

plaintext

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

Supported attributes:

Attribute	Type	Required	Description
`body`	string	Yes	The content of the note or reply.
`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.
`created_at`	string	No	Date time string, ISO 8601 formatted, such as `2016-03-11T03:45:40Z`. Requires administrator or project/group owner rights.

If successful, returns 201 Created and the created note object.

Example request:

shell

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"

Update a merge request thread note

Updates or resolves a specified thread note for a merge request.

plaintext

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

Supported attributes:

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 reopen the note. Exactly one of `body` or `resolved` must be set.

If successful, returns 200 OK and the updated note object.

Example request:

shell

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/<note_id>?body=comment"

Resolving a note:

shell

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/<note_id>?resolved=true"

Delete a merge request thread note

Deletes an existing thread note of a merge request.

plaintext

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

Supported attributes:

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.

If successful, returns 204 No Content.

Example request:

shell

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

Commits

List all commit discussion items

Lists all discussion items for a specified commit.

plaintext

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

Supported attributes:

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.

If successful, returns 200 OK and the same response attributes as List issue discussion items, with noteable_type set to Commit.

Example request:

shell

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

Example response:

json

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

json

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

Retrieve a commit discussion item

Retrieves a specified discussion item for a project commit.

plaintext

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

Supported attributes:

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.

If successful, returns 200 OK and the same response attributes as List commit discussion items.

Example request:

shell

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

Create a 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.

plaintext

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

Supported attributes:

Attribute	Type	Required	Description
`body`	string	Yes	The content of the thread.
`commit_id`	string	Yes	The SHA of a commit.
`id`	integer or string	Yes	The ID or URL-encoded path of the project.
`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[base_sha]`	string	Yes (if `position*` is supplied)	SHA of the parent commit.
`position[head_sha]`	string	Yes (if `position*` is supplied)	The SHA of this commit. Same as `commit_id`.
`position[start_sha]`	string	Yes (if `position*` is supplied)	SHA of the parent commit.
`position[position_type]`	string	Yes (if `position*` is supplied)	Type of the position reference. Allowed values: `text`, `image`, or `file`. `file` introduced in GitLab 16.4.
`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.

If successful, returns 201 Created and the created discussion object.

Example request:

shell

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 a commit thread

Adds a new note to the thread.

plaintext

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

Supported attributes:

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.
`created_at`	string	No	Date time string, ISO 8601 formatted, such as `2016-03-11T03:45:40Z`. Requires administrator or project/group owner rights.

If successful, returns 201 Created and the created note object.

Example request:

shell

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"

Update a commit thread note

Updates or resolves a specified thread note for a commit.

plaintext

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

Supported attributes:

Attribute	Type	Required	Description
`body`	string	No	The content of a note.
`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.

If successful, returns 200 OK and the updated note object.

Example request:

shell

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/<note_id>?body=comment"

Resolving a note:

shell

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/<note_id>?resolved=true"

Delete a commit discussion note

Deletes an existing discussion note of a commit.

plaintext

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

Supported attributes:

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.

If successful, returns 204 No Content.

Example request:

shell

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/<note_id>"