ownerstringrequired
repostringrequired
comment_idintegerrequired
comment_id parameter
Update an issue comment
patch
http://HOSTNAME/api/v3/repos/{owner}/{repo}/issues/comments/{comment_id}
Path Parameters
Body
application/json
Body
application/json
bodystringrequired
The contents of the comment.
Response
application/json
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}
Path Parameters
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
204
Response
delete/repos/{owner}/{repo}/issues/comments/{comment_id}
Path Parameters
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
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
Path Parameters
Query Parameters
application/json
Get an issue event
get
http://HOSTNAME/api/v3/repos/{owner}/{repo}/issues/events/{event_id}
Path Parameters
ownerstringrequired
repostringrequired
event_idintegerrequired
Response
application/json
Response
application/json
Response
Issue Event
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/{event_id}
Path Parameters
application/json
Get an issue
The API returns a 301 Moved Permanently status if the issue was
transferred to another repository. If
the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API
returns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read
access, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe
to the issues webhook.
Note: GitHub’s REST API v3 considers every pull request an issue, but not every issue is a pull request. For this
reason, “Issues” endpoints may return both issues and pull requests in the response. You can identify pull requests by
the pull_request key. Be aware that the id of a pull request returned from “Issues” endpoints will be an issue id. To find out the pull
request id, use the “List pull requests” endpoint.
get
http://HOSTNAME/api/v3/repos/{owner}/{repo}/issues/{issue_number}
Path Parameters
ownerstringrequired
repostringrequired
issue_numberintegerrequired
issue_number parameter
Response
application/json
Response
application/json
Response
Issue
Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
idintegerrequired
node_idstringrequired
urlstring(uri)required
URL for the issue
Example:https://api.github.com/repositories/42/issues/1
repository_urlstring(uri)required
labels_urlstringrequired
comments_urlstring(uri)required
events_urlstring(uri)required
html_urlstring(uri)required
numberintegerrequired
Number uniquely identifying the issue within its repository
Example:42
statestringrequired
State of the issue; either ‘open’ or ‘closed’
Example:open
titlestringrequired
Title of the issue
Example:Widget creation fails in Safari on OS X 10.8
bodystring | null
Contents of the issue
Example:It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?
userobject | nullrequired
Simple User
Show Child Parameters
labels
One Ofarrayrequired
Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository
Example:["bug","registration"]
Variant 1string
assigneeobject | nullrequired
Simple User
Show Child Parameters
assigneesarray | null[object]
Simple User
Show Child Parameters
milestoneobject | nullrequired
A collection of related issues and pull requests.
Show Child Parameters
lockedbooleanrequired
active_lock_reasonstring | null
commentsintegerrequired
pull_requestobject
Show Child Parameters
closed_atstring | null(date-time)required
created_atstring(date-time)required
updated_atstring(date-time)required
draftboolean
closed_byobject | null
Simple User
Show Child Parameters
body_htmlstring
body_textstring
timeline_urlstring(uri)
repositoryobject
A git repository
Show Child Parameters
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
author_associationstringrequired
How the author is associated with the repository.
Allowed values:COLLABORATORCONTRIBUTORFIRST_TIMERFIRST_TIME_CONTRIBUTORMANNEQUINMEMBERNONEOWNER
Example:OWNER
reactionsobject
Show Child Parameters
get/repos/{owner}/{repo}/issues/{issue_number}
Path Parameters
application/json