Read Issue

Read the contents of a GitHub issue.

The GitHub REST API classifies every pull request as an issue. However, issues can consist of other GitHub objects besides pull requests. This means that the /issues endpoint returns both issues and pull requests in the response. You can identify pull requests using the pull_request key. The id of a pull request returned from the /issues endpoint is its issue ID. To find the pull request ID, use the List pull requests endpoint.

Options

Field	Definition	Type	Required
Organization	Choose the organization that owns the repository containing the issue. The dropdown list displays the organizations for the authenticated user. The list is limited to 100 organizations. If the repository is under a personal account, select the -- Not In Org -- option.	Dropdown	TRUE
Repository	Choose the repository containing the issue. The dropdown list displays the repositories for the selected Organization. If you select the -- Input Repo Full Name -- option, then the card ignores the Organization selection and you must enter the full name of the repository in the Repository input field.	Dropdown	TRUE

Field

Definition

Type

Required

Organization

Choose the organization that owns the repository containing the issue.

The dropdown list displays the organizations for the authenticated user. The list is limited to 100 organizations.

If the repository is under a personal account, select the -- Not In Org -- option.

Dropdown

TRUE

Repository

Choose the repository containing the issue.

The dropdown list displays the repositories for the selected Organization.

If you select the -- Input Repo Full Name -- option, then the card ignores the Organization selection and you must enter the full name of the repository in the Repository input field.

Dropdown

TRUE

Input

Field	Definition	Type	Required
Repository
Full Name	The full name of the repository. This input field appears when you select -- Input Repo Full Name -- as the Repository option. The name must be formatted as <org_name>/<repo_name> if the repository is within an organization, or <owner_name>/<repo_name> if the repository is under a personal account. The card returns an error if the repository doesn't exist or the user doesn't have permission to access the repository.	Text	TRUE
Pull Request
Issue Number	The number assigned to the issue.	Number	TRUE

Output

Field	Definition	Type
Issue
Issue ID	Unique identifier of the issue.	Number
Issue Number	Number of the issue.	Text
Issue Global Node ID	The `node_id` value of the issue.	Text
Active Lock Reason	The reason for locking the issue or pull request conversation. The lock fails if you don't use one of these reasons: off-topic too heated resolved spam	Text
Author Association	The relationship of the issue's author to its repository: COLLABORATOR: The author has been invited to collaborate on the repository CONTRIBUTOR: The author has previously committed to the repository FIRST_TIMER: The author hasn't previously committed to GitHub FIRST_TIME_CONTRIBUTOR: The author hasn't previously committed to the repository MANNEQUIN: The author is a placeholder for an unclaimed user MEMBER: The author is a member of the organization that owns the repository NONE: The author has no association with the repository OWNER: The author is the owner of the repository	Text
HTML URL	URL of the issue.	Text
State	State of the issue. The issue can be open, closed, or all.	Text
Title	Title of the issue.	Text
Description	Description of the issue.	Text
User ID	Unique identifier of the user.	Text
Username	Username of the user who raised the issue.	Text
Labels	List of labels associated with the issue.	List of Objects
id	Unique identifier of the label.	Number
node_id	The node_id value of the label.	Text
name	Name of the label. Emoji can be added to label names, using either regular emoji or colon-style markup.	Text
color	The hexadecimal color code for the label, without the leading `#`.	Text
default	Indicates whether this label is the default label for the issue.	True/False
description	A short description of the label.	Text
Assignee ID	The unique identifier of the user to whom the issue is assigned.	Text
Assignee Username	Username of the user to whom the issue is assigned.	Text
Assignees	Users to whom the issue is assigned.	List of Objects
login	Username of the user to whom the issue is assigned.	Text
id	The unique identifier of the user to whom the issue is assigned.	Number
node_id	The node_id value of the assignee.	Text
avatar_url	URL of the avatar for the user.	Text
html_url	URL location of the user profile.	Text
type	Type of user to whom the issue is assigned.	Text
site_admin	Indicates whether the assignee is a site admin.	True/False
Milestone ID	Unique identifier of the milestone associated with the issue.	Text
Milestone Number	Milestone number associated with the issue.	Text
Milestone State	State of the milestone associated with the issue.	Text
Milestone Title	Title of the milestone associated with the issue.	Text
Is Locked?	Indicates whether the issue is locked.	True/False
Comments Count	Number of comments on the issue.	Number
Pull Request URL	URL location of pull request for the issue.	Text
Closed At	When the issue was closed.	Date & Time
Created At	Date and time when the object was created.	Date & Time
Updated At	The date and time when the issue was last updated.	Date & Time
Closed By	Metadata about the user who closed the updated issue, if it was closed.	Text

Read Issue

Options

Input

Output

Related topics