issues

Overview

Name	issues
Type	Resource
Id	github.issues.issues

Fields

Name	Datatype	Description
id	integer
repository_url	string
assignee	object	A GitHub user.
state_reason	string	The reason for the current state
node_id	string
active_lock_reason	string
body_text	string
reactions	object
comments_url	string
labels_url	string
closed_at	string
closed_by	object	A GitHub user.
state	string	State of the issue; either 'open' or 'closed'
created_at	string
performed_via_github_app	object	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.
html_url	string
labels	array	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
title	string	Title of the issue
updated_at	string
url	string	URL for the issue
body	string	Contents of the issue
comments	integer
user	object	A GitHub user.
events_url	string
assignees	array
number	integer	Number uniquely identifying the issue within its repository
repository	object	A repository on GitHub.
body_html	string
milestone	object	A collection of related issues and pull requests.
timeline_url	string
pull_request	object
draft	boolean
locked	boolean
author_association	string	How the author is associated with the repository.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	issue_number, owner, repo	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 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	SELECT		List 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_org	SELECT	org	List 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_repo	SELECT	owner, repo	List 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.
create	INSERT	owner, repo, data__title	Any 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.
lock	EXEC	issue_number, owner, repo	Users 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."
unlock	EXEC	issue_number, owner, repo	Users with push access can unlock an issue's conversation.
update	EXEC	issue_number, owner, repo	Issue owners and users with push access can edit an issue.