Search
K
GitHub v3 REST API

List issue comments for a repository

By default, Issue Comments are ordered by ascending ID.

get
http://HOSTNAME/api/v3/repos/{owner}/{repo}/issues/comments

Query Parameters

sortstring

One of created (when the repository was starred) or updated (when it was last pushed to).

Allowed values:createdupdated

Default:created

directionstring

Either asc or desc. Ignored without the sort parameter.

Allowed values:ascdesc

sincestring(date-time)

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

per_pageinteger

Results per page (max 100)

Default:30

pageinteger

Page number of the results to fetch.

Default:1

Path Parameters

ownerstringrequired
repostringrequired

Response

application/json

Response

Comments provide a way for people to collaborate on an issue.

idintegerrequired

Unique identifier of the issue comment

Example:42

node_idstringrequired
urlstring(uri)required

URL for the issue comment

Example:https://api.github.com/repositories/42/issues/comments/1

bodystring

Contents of the issue comment

Example:What version of Safari were you using when you observed this bug?

body_textstring
body_htmlstring
html_urlstring(uri)required
userobject | nullrequired

Simple User

Show Child Parameters
created_atstring(date-time)required

Example:2011-04-14T16:00:49Z

updated_atstring(date-time)required

Example:2011-04-14T16:00:49Z

issue_urlstring(uri)required
author_associationstringrequired

How the author is associated with the repository.

Allowed values:COLLABORATORCONTRIBUTORFIRST_TIMERFIRST_TIME_CONTRIBUTORMANNEQUINMEMBERNONEOWNER

Example:OWNER

performed_via_github_appobject | null

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

Show Child Parameters
reactionsobject
Show Child Parameters
get/repos/{owner}/{repo}/issues/comments
 
application/json

Get an issue comment

get
http://HOSTNAME/api/v3/repos/{owner}/{repo}/issues/comments/{comment_id}

Path Parameters

ownerstringrequired
repostringrequired
comment_idintegerrequired

comment_id parameter

Response

application/json

Response

Issue Comment

Comments provide a way for people to collaborate on an issue.

idintegerrequired

Unique identifier of the issue comment

Example:42

node_idstringrequired
urlstring(uri)required

URL for the issue comment

Example:https://api.github.com/repositories/42/issues/comments/1

bodystring

Contents of the issue comment

Example:What version of Safari were you using when you observed this bug?

body_textstring
body_htmlstring
html_urlstring(uri)required
userobject | nullrequired

Simple User

Show Child Parameters
created_atstring(date-time)required

Example:2011-04-14T16:00:49Z

updated_atstring(date-time)required

Example:2011-04-14T16:00:49Z

issue_urlstring(uri)required
author_associationstringrequired

How the author is associated with the repository.

Allowed values:COLLABORATORCONTRIBUTORFIRST_TIMERFIRST_TIME_CONTRIBUTORMANNEQUINMEMBERNONEOWNER

Example:OWNER

performed_via_github_appobject | null

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

Show Child Parameters
reactionsobject
Show Child Parameters
get/repos/{owner}/{repo}/issues/comments/{comment_id}
 
application/json

Update an issue comment

patch
http://HOSTNAME/api/v3/repos/{owner}/{repo}/issues/comments/{comment_id}

Path Parameters

ownerstringrequired
repostringrequired
comment_idintegerrequired

comment_id parameter

Body

application/json
bodystringrequired

The contents of the comment.

Response

application/json

Response

Issue Comment

Comments provide a way for people to collaborate on an issue.

idintegerrequired

Unique identifier of the issue comment

Example:42

node_idstringrequired
urlstring(uri)required

URL for the issue comment

Example:https://api.github.com/repositories/42/issues/comments/1

bodystring

Contents of the issue comment

Example:What version of Safari were you using when you observed this bug?

body_textstring
body_htmlstring
html_urlstring(uri)required
userobject | nullrequired

Simple User

Show Child Parameters
created_atstring(date-time)required

Example:2011-04-14T16:00:49Z

updated_atstring(date-time)required

Example:2011-04-14T16:00:49Z

issue_urlstring(uri)required
author_associationstringrequired

How the author is associated with the repository.

Allowed values:COLLABORATORCONTRIBUTORFIRST_TIMERFIRST_TIME_CONTRIBUTORMANNEQUINMEMBERNONEOWNER

Example:OWNER

performed_via_github_appobject | null

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

Show Child Parameters
reactionsobject
Show Child Parameters
patch/repos/{owner}/{repo}/issues/comments/{comment_id}

Body

{ "body": "Me too" }
 
application/json

Delete an issue comment

delete
http://HOSTNAME/api/v3/repos/{owner}/{repo}/issues/comments/{comment_id}

Path Parameters

ownerstringrequired
repostringrequired
comment_idintegerrequired

comment_id parameter

Response

204

Response

delete/repos/{owner}/{repo}/issues/comments/{comment_id}
 
204

List issue events for a repository

get
http://HOSTNAME/api/v3/repos/{owner}/{repo}/issues/events

Query Parameters

per_pageinteger

Results per page (max 100)

Default:30

pageinteger

Page number of the results to fetch.

Default:1

Path Parameters

ownerstringrequired
repostringrequired

Response

application/json

Response

Issue Event

idintegerrequired

Example:1

node_idstringrequired

Example:MDEwOklzc3VlRXZlbnQx

urlstring(uri)required

Example:https://api.github.com/repos/octocat/Hello-World/issues/events/1

actorobject | nullrequired

Simple User

Show Child Parameters
eventstringrequired

Example:closed

commit_idstring | nullrequired

Example:6dcb09b5b57875f334f61aebed695e2e4193db5e

commit_urlstring | nullrequired

Example:https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e

created_atstring(date-time)required

Example:2011-04-14T16:00:49Z

issueobject | null

Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.

Show Child Parameters
labelobject

Issue Event Label

Show Child Parameters
assigneeobject | null

Simple User

Show Child Parameters
assignerobject | null

Simple User

Show Child Parameters
review_requesterobject | null

Simple User

Show Child Parameters
requested_reviewerobject | null

Simple User

Show Child Parameters
requested_teamobject

Groups of organization members that gives permissions on specified repositories.

Show Child Parameters
dismissed_reviewobject
Show Child Parameters
milestoneobject

Issue Event Milestone

Show Child Parameters
project_cardobject

Issue Event Project Card

Show Child Parameters
renameobject

Issue Event Rename

Show Child Parameters
author_associationstring

How the author is associated with the repository.

Allowed values:COLLABORATORCONTRIBUTORFIRST_TIMERFIRST_TIME_CONTRIBUTORMANNEQUINMEMBERNONEOWNER

Example:OWNER

lock_reasonstring | null
performed_via_github_appobject | null

GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.

Show Child Parameters
get/repos/{owner}/{repo}/issues/events
 
application/json