Read Pull Request

Read a pull request from GitHub.

Options

Field Definition Type Required
Organization A list of available organizations in GitHub. Dropdown TRUE
Repository Repository that contains the pull request. Dropdown TRUE

Input

Field Definition Type Required
Pull Request Number Number of the pull request to read. String FALSE

Output

Field Definition Type
State State of the pull request. String
Title Title of the pull request. String
Description Description of the pull request. String
Author Association Relationship of the author to the subject of the comment. String
Username Login of the user who raised the pull request. String
User Node ID Node ID of the user. String
User ID ID of the user who raised the issue. Number
Assignee Username Login of the user to whom the pull request is assigned. String
Assignee Node ID Node ID of the assignee. String
Merged By ID of the user to whom the pull request is assigned. String
Assignees Users to whom the pull request is assigned. List of Objects
Requested Reviewers Users who were requested to review the pull request. List of Objects
Requested Teams Teams who were requested to review the pull request. List of Objects
Labels List of labels associated with the pull request. List of Objects
Is Mergeable? If true, the pull request can be merged. If null, GitHub is determining whether the pull can be merged. Boolean
Mergeable State Current state of the merge; one of: clean, dirty, or unstable. String
Pull Request ID ID of the pull request. Number
Pull Request Node ID Node ID of the pull request. String
Pull Request Number Pull request's URL. String
Milestone Title Title of the milestone associated with the pull request. String
Milestone ID Unique identifier for the milestone with which the pull request is associated. Number
Merge Commit SHA State of the milestone. String
Milestone Number Milestone number milestone with which the pull request is associated. Number
Assignee ID ID of the user to whom the pull request is assigned. Number
Active Lock Reason Reason for a lock, if any. String
BASE Branch Base branch of the pull request. String
HEAD Branch Head branch of the pull request. String
Diff URL A URL that contains a diff for the pull request. String
HTML URL A URL that contains a human-readable HTML version of the pull request. String
Patch URL A URL that contains a patch for the pull request. String
Created At Time the pull request was created. Date & Time
Merged At Time the pull request was merged. Date & Time
Closed At Time the pull request was closed. Date & Time
Updated At Time the pull request was last updated. Date & Time
Is Merged? If true, the pull request has been merged. Boolean
Maintainer Can Modify? If true, the upstream maintainers can modify the pull request. Boolean
Is Locked? If true, the pull request is locked. Boolean
Is Draft? If true, the pull request is a draft. Boolean
Additions Count Number of additions included in the pull request. Number
Review Comments Count Number of review comments included in the pull request. Number
Comments Count Number of comments included in the pull request. Number
Deletions Count Number of deletions included in the pull request. Number
Changed Files Count Number of files changed by the pull request. Number
Commits Count Number of commits included in the pull request. Number

Related topics

GitHub connector

About the elements of Okta Workflows

GitHub API documentation