Read Issue

Read the contents of an issue by issue number in GitHub.

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.

Options

Field Definition Type Required
Organization Organization for the repository that contains the issue. Dropdown TRUE
Repository Repository that contains the issue. Dropdown TRUE

Input

Field Definition Type Required
Issue Number 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. String
Issue Global Node ID node_id value of the issue. String
Active Lock Reason Reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:

  • off-topic

  • too heated

  • resolved

  • spam

 String
Author Association Indicates the relationship of the issue's author to its repository; options are:

  • COLLABORATOR: Author has been invited to collaborate on the repository

  • CONTRIBUTOR: Author has previously committed to the repository

  • FIRST_TIMER: Author has not previously committed to GitHub

  • FIRST_TIME_CONTRIBUTOR: Author has not previously committed to the repository

  • MANNEQUIN: Author is a placeholder for an unclaimed user

  • MEMBER: Author is a member of the organization that owns the repository

  • NONE: Author has no association with the repository

  • OWNER: Author is the owner of the repository

 String
HTML URL URL location of the issue. String
State State of the issue; can be open, closed, or all. String
Title Title of the issue. String
Description Description of the issue. String
User ID Unique identifier of the user. String
Username Login of the user who raised the issue. String
Labels List of labels associated with the issue. List of objects
id: Unique identifier of the label. Number
node_id: node_id value of the label. String
name: Name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. String
color: Hexadecimal color code for the label, without the leading #. String
default: Indicates whether the label is the default label (True) for the issue or not (False). Boolean
description: Short description of the label. String
Assignee ID Unique identifier of the user to whom the issue is assigned. String
Assignee Username Login of the user to whom the issue is assigned. String
Assignees Users to whom the issue is assigned. List of objects
login: Login of the user to whom the issue is assigned. String
id: Unique identifier of the user to whom the issue is assigned. Number
node_id: node_id value of the assignee. String
avatar_url: URL of the avatar for the user. String
html_url: URL location of the user profile. String
type: Type of user to whom the issue is assigned. String
site_admin: Indicates whether the assignee is a site admin (True) or not (False). Boolean
Milestone ID Unique identifier of the milestone associated with the issue. String
Milestone Number Milestone number associated with the issue. String
Milestone State State of the milestone associated with the issue. String
Milestone Title Title of the milestone associated with the issue. String
Is Locked? Indicates whether the issue is locked; options are True or False. Boolean
Comments Count Number of comments on the issue. Number
Pull Request URL URL location of pull request for the issue. String
Closed At When the issue was closed. Date & Time
Created At

Date and time when the object was created.

 Date & Time
Updated At When the issue was last updated. Date & Time
Closed By Metadata about the user who closed the updated issue, if it was closed. String

Related topics

GitHub connector

Workflow elements

GitHub API documentation