git.pulls.list-comments

List comments, including inline ones

GET /git/api/repositories/{repoId}/pulls/{prNumber}/commentsIAM git:GetPullRequestRead

Request syntax

GET /git/api/repositories/{repoId}/pulls/{prNumber}/comments

Path parameters

  • repoIdRequired

    string

    Constraints: uuid

  • prNumberRequired

    number

    Constraints: integer, min 1

Response

200 with the comments: id, authorIamUserId, body, `bodyHtml` (the Markdown rendered), replyToId, the line anchor (filePath, line, side, commitOid) for an inline one, and resolvedAt/resolvedByIamUserId on a resolved thread’s first comment.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Fields of data

  • [].​idAlways

    string

    The comment id
  • [].​prIdAlways

    string

    The pull request
  • [].​orgIdAlways

    string

    The organization
  • [].​authorIamUserIdAlways

    string

    Who wrote it
  • [].​bodyAlways

    string

    The comment (Markdown)
  • [].​filePathAlways

    string, may be null

    For an inline comment, the file; null otherwise
  • [].​lineAlways

    number, may be null

    For an inline comment, the line; null otherwise
  • [].​sideAlways

    one of old, new, may be null

    For an inline comment, the old or new side of the diff; null otherwise
  • [].​commitOidAlways

    string, may be null

    For an inline comment, the head commit its line refers to
  • [].​resolvedAtAlways

    string, may be null

    When the thread was resolved (on a thread's first comment); null when open
  • [].​resolvedByIamUserIdAlways

    string, may be null

    Who resolved the thread; null when open
  • [].​replyToIdAlways

    string, may be null

    The comment this replies to; null for a thread root
  • [].​createdAtAlways

    string

    When it was written
  • [].​updatedAtAlways

    string

    When it last changed
  • [].​bodyHtmlAlways

    string, may be null

    The comment rendered to HTML (sanitised, #n linked)

Checked against the handlers: every route test validates their answers against this schema.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow git:GetPullRequest on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud git pulls list-comments repoId prNumber

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_git_pulls_list-comments.