List all comments on an issue

GET

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

const url = 'https://gitea.com/api/v1/repos/example/example/issues/1/comments';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://gitea.com/api/v1/repos/example/example/issues/1/comments \
  --header 'Authorization: Basic <credentials>'

Authorizations

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

application/json

Array<object>

Comment represents a comment on a commit or issue

object

assets

Attachments contains files attached to the comment

Array<object>

Attachment a generic attachment

object

browser_download_url

DownloadURL is the URL to download the attachment

string format: uri

created_at

Created is the time when the attachment was uploaded

string format: date-time

download_count

DownloadCount is the number of times the attachment has been downloaded

integer format: int64

ID is the unique identifier for the attachment

integer format: int64

name

Name is the filename of the attachment

string

size

Size is the file size in bytes

integer format: int64

uuid

UUID is the unique identifier for the attachment file

string

body

Body contains the comment text content

string

created_at

string format: date-time

html_url

HTMLURL is the web URL for viewing the comment

string format: uri

ID is the unique identifier for the comment

integer format: int64

issue_url

IssueURL is the API URL for the issue

string format: uri

original_author

OriginalAuthor is the original author name (for imported comments)

string

original_author_id

OriginalAuthorID is the original author ID (for imported comments)

integer format: int64

pull_request_url

PRURL is the API URL for the pull request (if applicable)

string format: uri

updated_at

string format: date-time

user

User represents a user

object

active

Is user active

boolean

avatar_url

URL to the user’s avatar

string format: uri

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 gitea page

string format: uri

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

string

login_name

Identifier of the user, provided by the external authenticator (if configured)

string

prohibit_login

Is user login prohibited

boolean

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

Allowed values: public limited private

website

The user’s website

string

Example

[
  {
    "user": {
      "visibility": "public"
    }
  }
]

404

APINotFound is a not found empty response