Skip to main content

issues

Overview

Nameissues
TypeResource
Idgithub.issues.issues

Fields

NameDatatypeDescription
idinteger
active_lock_reasonstring
assigneeobjectA GitHub user.
assigneesarray
author_associationstringHow the author is associated with the repository.
bodystringContents of the issue
body_htmlstring
body_textstring
closed_atstring
closed_byobjectA GitHub user.
commentsinteger
comments_urlstring
created_atstring
draftboolean
events_urlstring
html_urlstring
labelsarrayLabels 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
labels_urlstring
lockedboolean
milestoneobjectA collection of related issues and pull requests.
node_idstring
numberintegerNumber uniquely identifying the issue within its repository
performed_via_github_appobjectGitHub 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.
pull_requestobject
reactionsobject
repositoryobjectA repository on GitHub.
repository_urlstring
statestringState of the issue; either 'open' or 'closed'
state_reasonstringThe reason for the current state
timeline_urlstring
titlestringTitle of the issue
updated_atstring
urlstringURL for the issue
userobjectA GitHub user.

Methods

NameAccessible byRequired ParamsDescription
getSELECTissue_number, owner, repoThe 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 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.
listSELECTList issues assigned to the authenticated user across all visible repositories including owned repositories, member
repositories, and organization repositories. You can use the filter query parameter to fetch issues that are not
necessarily assigned to you.


Note: GitHub's REST API 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.
list_for_orgSELECTorgList issues in an organization assigned to the authenticated user.

Note: GitHub's REST API 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.
list_for_repoSELECTowner, repoList issues in a repository. Only open issues will be listed.

Note: GitHub's REST API 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.
createINSERTowner, repo, data__titleAny user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status.

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. See "Secondary rate limits" and "Dealing with secondary rate limits" for details.
lockEXECissue_number, owner, repoUsers with push access can lock an issue or pull request's conversation.

Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP verbs."
unlockEXECissue_number, owner, repoUsers with push access can unlock an issue's conversation.
updateEXECissue_number, owner, repoIssue owners and users with push access can edit an issue.