List all comments on an issue

GET

/repos/{owner}/{repo}/issues/{index}/comments

Authorizations

• BasicAuth
• AuthorizationHeaderToken
• SudoParam
• SudoHeader
• TOTPHeader

Parameters

Path Parameters

owner

required

string

Owner of the repo

repo

required

string

Name of the repo

index

required

integer format: int64

Index of the issue

Query Parameters

since

string format: date-time

If provided, only comments updated since the specified time are returned.

before

string format: date-time

If provided, only comments updated before the provided time are returned.

Responses

200

CommentList

Media type application/json

Array<object>

Comment represents a comment on a commit or issue

object

assets

The attachments to the comment

Array<object>

Attachment a generic attachment

object

browser_download_url

string

created_at

string format: date-time

download_count

integer format: int64

id

integer format: int64

name

string

size

integer format: int64

type

string

Allowed values: attachment external

uuid

string

body

The body of the comment

string

created_at

The time of the comment’s creation

string format: date-time

html_url

The HTML URL of the comment

string

id

The identifier of the comment

integer format: int64

issue_url

The HTML URL of the issue if the comment is posted on an issue, else empty string

string

original_author

The original author that posted the comment if it was not posted locally, else empty string

string

original_author_id

The ID of the original author that posted the comment if it was not posted locally, else 0

integer format: int64

pull_request_url

The HTML URL of the pull request if the comment is posted on a pull request, else empty string

string

updated_at

The time of the comment’s update

string format: date-time

user

User represents a user

object

active

Is user active

boolean

avatar_url

URL to the user’s avatar

string

created

string format: date-time

description

The user’s description

string

email

string format: email

followers_count

User counts

integer format: int64

following_count

integer format: int64

full_name

The user’s full name

string

html_url

URL to the user’s profile page

string

id

The user’s id

integer format: int64

is_admin

Is the user an administrator

boolean

language

User locale

string

last_login

string format: date-time

location

The user’s location

string

login

The user’s username

string

login_name

The user’s authentication sign-in name.

string

default: empty

prohibit_login

Is user login prohibited

boolean

pronouns

The user’s pronouns

string

restricted

Is user restricted

boolean

source_id

The ID of the user’s Authentication Source

integer format: int64

starred_repos_count

integer format: int64

visibility

User visibility level option: public, limited, private

string

website

The user’s website

string

Example

[
  {
    "assets": [
      {
        "type": "attachment"
      }
    ],
    "user": {
      "login_name": "empty"
    }
  }
]

Headers

X-Total-Count

integer format: int64

The total number of comments

404

APINotFound is a not found error response

Media type application/json

object

errors

Array<string>

message

string

url

string

Example ^generated

{
  "errors": [
    "example"
  ],
  "message": "example",
  "url": "example"
}

422

APIValidationError is error format response related to input validation

Media type application/json

object

message

string

url

string

Example ^generated

{
  "message": "example",
  "url": "example"
}

500

APIInternalServerError is an error that is raised when an internal server error occurs

Media type application/json

object

message

string

url

string

Example ^generated

{
  "message": "example",
  "url": "example"
}