External DocumentationTo learn more, visit the GitHub documentation.
Parameters
| Parameter | Description |
|---|---|
| Direction | The direction of the sort. Can be either asc or desc. Default: desc when sort is created or sort is not specified, otherwise asc. |
| Owner | The organization or person who owns the repository. github.com// |
| Page | Page number of the results to fetch. |
| Per Page | The number of results per page (max 100). |
| Repo | Name of the repository owned by the owner. github.com// |
| Return All Pages | Automatically fetch all resources, page by page. |
| Sort | What to sort results by. Can be either created, updated, popularity (comment count) or long-running (age, filtering by pulls updated in the last month). |
| Source Branch | Filter pulls by head user or head organization and branch name in the format of user:ref-name or organization:ref-name. For example: github:new-script-format or octocat:test-branch. |
| State | Either open, closed, or all to filter by state. |
| Target Branch | Filter pulls by base branch name. Example: gh-pages. |
Example Output
[
{
"url": "<string>",
"id": 1456789448,
"node_id": "<string>",
"html_url": "<string>",
"diff_url": "<string>",
"patch_url": "<string>",
"issue_url": "<string>",
"number": 27640,
"state": "<string>",
"locked": false,
"title": "<string>",
"user": {
"login": "<string>",
"id": 76961340,
"node_id": "<string>",
"avatar_url": "<string>",
"gravatar_id": "<string>",
"url": "<string>",
"html_url": "<string>",
"followers_url": "<string>",
"following_url": "<string>",
"gists_url": "<string>",
"starred_url": "<string>",
"subscriptions_url": "<string>",
"organizations_url": "<string>",
"repos_url": "<string>",
"events_url": "<string>",
"received_events_url": "<string>",
"type": "<string>",
"user_view_type": "<string>",
"site_admin": false
},
"body": "<string>",
"created_at": "2021-10-28T16:05:50Z",
"updated_at": "2021-10-28T16:05:50Z",
"closed_at": null,
"merged_at": null,
"merge_commit_sha": null,
"assignee": {
"login": "<string>",
"id": 104339509,
"node_id": "<string>",
"avatar_url": "<string>",
"gravatar_id": "<string>",
"url": "<string>",
"html_url": "<string>",
"followers_url": "<string>",
"following_url": "<string>",
"gists_url": "<string>",
"starred_url": "<string>",
"subscriptions_url": "<string>",
"organizations_url": "<string>",
"repos_url": "<string>",
"events_url": "<string>",
"received_events_url": "<string>",
"type": "<string>",
"user_view_type": "<string>",
"site_admin": false
},
"assignees": [
{
"login": "<string>",
"id": 108374488,
"node_id": "<string>",
"avatar_url": "<string>",
"gravatar_id": "<string>",
"url": "<string>",
"html_url": "<string>",
"followers_url": "<string>",
"following_url": "<string>",
"gists_url": "<string>",
"starred_url": "<string>",
"subscriptions_url": "<string>",
"organizations_url": "<string>",
"repos_url": "<string>",
"events_url": "<string>",
"received_events_url": "<string>",
"type": "<string>",
"user_view_type": "<string>",
"site_admin": false
}
],
"requested_reviewers": [
{
"login": "<string>",
"id": 16620124,
"node_id": "<string>",
"avatar_url": "<string>",
"gravatar_id": "<string>",
"url": "<string>",
"html_url": "<string>",
"followers_url": "<string>",
"following_url": "<string>",
"gists_url": "<string>",
"starred_url": "<string>",
"subscriptions_url": "<string>",
"organizations_url": "<string>",
"repos_url": "<string>",
"events_url": "<string>",
"received_events_url": "<string>",
"type": "<string>",
"user_view_type": "<string>",
"site_admin": false
},
{
"login": "<string>",
"id": 12085883,
"node_id": "<string>",
"avatar_url": "<string>",
"gravatar_id": "<string>",
"url": "<string>",
"html_url": "<string>",
"followers_url": "<string>",
"following_url": "<string>",
"gists_url": "<string>",
"starred_url": "<string>",
"subscriptions_url": "<string>",
"organizations_url": "<string>",
"repos_url": "<string>",
"events_url": "<string>",
"received_events_url": "<string>",
"type": "<string>",
"user_view_type": "<string>",
"site_admin": false
}
],
"requested_teams": [
{
"name": "<string>",
"id": 4200875,
"node_id": "<string>",
"slug": "<string>",
"description": "<string>",
"privacy": "<string>",
"notification_setting": "<string>",
"url": "<string>",
"html_url": "<string>",
"members_url": "<string>",
"repositories_url": "<string>",
"permission": "<string>",
"parent": null
}
],
"labels": [
{
"id": 1581583593,
"node_id": "<string>",
"url": "<string>",
"name": "<string>",
"color": "<string>",
"default": false,
"description": "<string>"
},
{
"id": 7733968347,
"node_id": "<string>",
"url": "<string>",
"name": "<string>",
"color": "<string>",
"default": false,
"description": "<string>"
}
],
"milestone": null,
"draft": false,
"commits_url": "<string>",
"review_comments_url": "<string>",
"review_comment_url": "<string>",
"comments_url": "<string>",
"statuses_url": "<string>",
"head": {
"label": "<string>",
"ref": "<string>",
"sha": "<string>",
"user": {
"login": "<string>",
"id": 35267333,
"node_id": "<string>",
"avatar_url": "<string>",
"gravatar_id": "<string>",
"url": "<string>",
"html_url": "<string>",
"followers_url": "<string>",
"following_url": "<string>",
"gists_url": "<string>",
"starred_url": "<string>",
"subscriptions_url": "<string>",
"organizations_url": "<string>",
"repos_url": "<string>",
"events_url": "<string>",
"received_events_url": "<string>",
"type": "<string>",
"user_view_type": "<string>",
"site_admin": false
},
"repo": {
"id": 1315417950,
"node_id": "<string>",
"name": "<string>",
"full_name": "<string>",
"private": false,
"owner": {
"login": "<string>",
"id": 30302157,
"node_id": "<string>",
"avatar_url": "<string>",
"gravatar_id": "<string>",
"url": "<string>",
"html_url": "<string>",
"followers_url": "<string>",
"following_url": "<string>",
"gists_url": "<string>",
"starred_url": "<string>",
"subscriptions_url": "<string>",
"organizations_url": "<string>",
"repos_url": "<string>",
"events_url": "<string>",
"received_events_url": "<string>",
"type": "<string>",
"user_view_type": "<string>",
"site_admin": false
},
"html_url": "<string>",
"description": "<string>",
"fork": true,
"url": "<string>",
"forks_url": "<string>",
"keys_url": "<string>",
"collaborators_url": "<string>",
"teams_url": "<string>",
"hooks_url": "<string>",
"issue_events_url": "<string>",
"events_url": "<string>",
"assignees_url": "<string>",
"branches_url": "<string>",
"tags_url": "<string>",
"blobs_url": "<string>",
"git_tags_url": "<string>",
"git_refs_url": "<string>",
"trees_url": "<string>",
"statuses_url": "<string>",
"languages_url": "<string>",
"stargazers_url": "<string>",
"contributors_url": "<string>",
"subscribers_url": "<string>",
"subscription_url": "<string>",
"commits_url": "<string>",
"git_commits_url": "<string>",
"comments_url": "<string>",
"issue_comment_url": "<string>",
"contents_url": "<string>",
"compare_url": "<string>",
"merges_url": "<string>",
"archive_url": "<string>",
"downloads_url": "<string>",
"issues_url": "<string>",
"pulls_url": "<string>",
"milestones_url": "<string>",
"notifications_url": "<string>",
"labels_url": "<string>",
"releases_url": "<string>",
"deployments_url": "<string>",
"created_at": "2021-10-28T16:05:50Z",
"updated_at": "2021-10-28T16:05:50Z",
"pushed_at": "2021-10-28T16:05:50Z",
"git_url": "<string>",
"ssh_url": "<string>",
"clone_url": "<string>",
"svn_url": "<string>",
"homepage": "<string>",
"size": 27434,
"stargazers_count": 1,
"watchers_count": 2,
"language": "<string>",
"has_issues": false,
"has_projects": true,
"has_downloads": true,
"has_wiki": true,
"has_pages": false,
"has_discussions": false,
"forks_count": 2,
"mirror_url": null,
"archived": false,
"disabled": false,
"open_issues_count": 2,
"license": {
"key": "<string>",
"name": "<string>",
"spdx_id": "<string>",
"url": "<string>",
"node_id": "<string>"
},
"allow_forking": true,
"is_template": false,
"web_commit_signoff_required": false,
"topics": [],
"visibility": "<string>",
"forks": 2,
"open_issues": 1,
"watchers": 1,
"default_branch": "<string>"
}
},
"base": {
"label": "<string>",
"ref": "<string>",
"sha": "<string>",
"user": {
"login": "<string>",
"id": 11029119,
"node_id": "<string>",
"avatar_url": "<string>",
"gravatar_id": "<string>",
"url": "<string>",
"html_url": "<string>",
"followers_url": "<string>",
"following_url": "<string>",
"gists_url": "<string>",
"starred_url": "<string>",
"subscriptions_url": "<string>",
"organizations_url": "<string>",
"repos_url": "<string>",
"events_url": "<string>",
"received_events_url": "<string>",
"type": "<string>",
"user_view_type": "<string>",
"site_admin": false
},
"repo": {
"id": 122891050,
"node_id": "<string>",
"name": "<string>",
"full_name": "<string>",
"private": false,
"owner": {
"login": "<string>",
"id": 8794679,
"node_id": "<string>",
"avatar_url": "<string>",
"gravatar_id": "<string>",
"url": "<string>",
"html_url": "<string>",
"followers_url": "<string>",
"following_url": "<string>",
"gists_url": "<string>",
"starred_url": "<string>",
"subscriptions_url": "<string>",
"organizations_url": "<string>",
"repos_url": "<string>",
"events_url": "<string>",
"received_events_url": "<string>",
"type": "<string>",
"user_view_type": "<string>",
"site_admin": false
},
"html_url": "<string>",
"description": "<string>",
"fork": false,
"url": "<string>",
"forks_url": "<string>",
"keys_url": "<string>",
"collaborators_url": "<string>",
"teams_url": "<string>",
"hooks_url": "<string>",
"issue_events_url": "<string>",
"events_url": "<string>",
"assignees_url": "<string>",
"branches_url": "<string>",
"tags_url": "<string>",
"blobs_url": "<string>",
"git_tags_url": "<string>",
"git_refs_url": "<string>",
"trees_url": "<string>",
"statuses_url": "<string>",
"languages_url": "<string>",
"stargazers_url": "<string>",
"contributors_url": "<string>",
"subscribers_url": "<string>",
"subscription_url": "<string>",
"commits_url": "<string>",
"git_commits_url": "<string>",
"comments_url": "<string>",
"issue_comment_url": "<string>",
"contents_url": "<string>",
"compare_url": "<string>",
"merges_url": "<string>",
"archive_url": "<string>",
"downloads_url": "<string>",
"issues_url": "<string>",
"pulls_url": "<string>",
"milestones_url": "<string>",
"notifications_url": "<string>",
"labels_url": "<string>",
"releases_url": "<string>",
"deployments_url": "<string>",
"created_at": "2021-10-28T16:05:50Z",
"updated_at": "2021-10-28T16:05:50Z",
"pushed_at": "2021-10-28T16:05:50Z",
"git_url": "<string>",
"ssh_url": "<string>",
"clone_url": "<string>",
"svn_url": "<string>",
"homepage": "<string>",
"size": 170213,
"stargazers_count": 1499,
"watchers_count": 296,
"language": "<string>",
"has_issues": true,
"has_projects": false,
"has_downloads": true,
"has_wiki": true,
"has_pages": false,
"has_discussions": true,
"forks_count": 816,
"mirror_url": null,
"archived": false,
"disabled": false,
"open_issues_count": 459,
"license": {
"key": "<string>",
"name": "<string>",
"spdx_id": "<string>",
"url": "<string>",
"node_id": "<string>"
},
"allow_forking": true,
"is_template": false,
"web_commit_signoff_required": false,
"topics": [],
"visibility": "<string>",
"forks": 400,
"open_issues": 375,
"watchers": 1591,
"default_branch": "<string>"
}
},
"_links": {
"self": {
"href": "<string>"
},
"html": {
"href": "<string>"
},
"issue": {
"href": "<string>"
},
"comments": {
"href": "<string>"
},
"review_comments": {
"href": "<string>"
},
"review_comment": {
"href": "<string>"
},
"commits": {
"href": "<string>"
},
"statuses": {
"href": "<string>"
}
},
"author_association": "<string>",
"auto_merge": null,
"active_lock_reason": null
},
{
"url": "<string>",
"id": 977170535,
"node_id": "<string>",
"html_url": "<string>",
"diff_url": "<string>",
"patch_url": "<string>",
"issue_url": "<string>",
"number": 32741,
"state": "<string>",
"locked": false,
"title": "<string>",
"user": {
"login": "<string>",
"id": 16933780,
"node_id": "<string>",
"avatar_url": "<string>",
"gravatar_id": "<string>",
"url": "<string>",
"html_url": "<string>",
"followers_url": "<string>",
"following_url": "<string>",
"gists_url": "<string>",
"starred_url": "<string>",
"subscriptions_url": "<string>",
"organizations_url": "<string>",
"repos_url": "<string>",
"events_url": "<string>",
"received_events_url": "<string>",
"type": "<string>",
"user_view_type": "<string>",
"site_admin": false
},
"body": "<string>",
"created_at": "2021-10-28T16:05:50Z",
"updated_at": "2021-10-28T16:05:50Z",
"closed_at": null,
"merged_at": null,
"merge_commit_sha": null,
"assignee": {
"login": "<string>",
"id": 39399091,
"node_id": "<string>",
"avatar_url": "<string>",
"gravatar_id": "<string>",
"url": "<string>",
"html_url": "<string>",
"followers_url": "<string>",
"following_url": "<string>",
"gists_url": "<string>",
"starred_url": "<string>",
"subscriptions_url": "<string>",
"organizations_url": "<string>",
"repos_url": "<string>",
"events_url": "<string>",
"received_events_url": "<string>",
"type": "<string>",
"user_view_type": "<string>",
"site_admin": false
},
"assignees": [
{
"login": "<string>",
"id": 105508408,
"node_id": "<string>",
"avatar_url": "<string>",
"gravatar_id": "<string>",
"url": "<string>",
"html_url": "<string>",
"followers_url": "<string>",
"following_url": "<string>",
"gists_url": "<string>",
"starred_url": "<string>",
"subscriptions_url": "<string>",
"organizations_url": "<string>",
"repos_url": "<string>",
"events_url": "<string>",
"received_events_url": "<string>",
"type": "<string>",
"user_view_type": "<string>",
"site_admin": false
}
],
"requested_reviewers": [
{
"login": "<string>",
"id": 11655611,
"node_id": "<string>",
"avatar_url": "<string>",
"gravatar_id": "<string>",
"url": "<string>",
"html_url": "<string>",
"followers_url": "<string>",
"following_url": "<string>",
"gists_url": "<string>",
"starred_url": "<string>",
"subscriptions_url": "<string>",
"organizations_url": "<string>",
"repos_url": "<string>",
"events_url": "<string>",
"received_events_url": "<string>",
"type": "<string>",
"user_view_type": "<string>",
"site_admin": false
}
],
"requested_teams": [
{
"name": "<string>",
"id": 2903523,
"node_id": "<string>",
"slug": "<string>",
"description": "<string>",
"privacy": "<string>",
"notification_setting": "<string>",
"url": "<string>",
"html_url": "<string>",
"members_url": "<string>",
"repositories_url": "<string>",
"permission": "<string>",
"parent": null
}
],
"labels": [
{
"id": 4242153242,
"node_id": "<string>",
"url": "<string>",
"name": "<string>",
"color": "<string>",
"default": false,
"description": "<string>"
}
],
"milestone": null,
"draft": false,
"commits_url": "<string>",
"review_comments_url": "<string>",
"review_comment_url": "<string>",
"comments_url": "<string>",
"statuses_url": "<string>",
"head": {
"label": "<string>",
"ref": "<string>",
"sha": "<string>",
"user": {
"login": "<string>",
"id": 60723664,
"node_id": "<string>",
"avatar_url": "<string>",
"gravatar_id": "<string>",
"url": "<string>",
"html_url": "<string>",
"followers_url": "<string>",
"following_url": "<string>",
"gists_url": "<string>",
"starred_url": "<string>",
"subscriptions_url": "<string>",
"organizations_url": "<string>",
"repos_url": "<string>",
"events_url": "<string>",
"received_events_url": "<string>",
"type": "<string>",
"user_view_type": "<string>",
"site_admin": false
},
"repo": {
"id": 255792286,
"node_id": "<string>",
"name": "<string>",
"full_name": "<string>",
"private": false,
"owner": {
"login": "<string>",
"id": 48749184,
"node_id": "<string>",
"avatar_url": "<string>",
"gravatar_id": "<string>",
"url": "<string>",
"html_url": "<string>",
"followers_url": "<string>",
"following_url": "<string>",
"gists_url": "<string>",
"starred_url": "<string>",
"subscriptions_url": "<string>",
"organizations_url": "<string>",
"repos_url": "<string>",
"events_url": "<string>",
"received_events_url": "<string>",
"type": "<string>",
"user_view_type": "<string>",
"site_admin": false
},
"html_url": "<string>",
"description": "<string>",
"fork": true,
"url": "<string>",
"forks_url": "<string>",
"keys_url": "<string>",
"collaborators_url": "<string>",
"teams_url": "<string>",
"hooks_url": "<string>",
"issue_events_url": "<string>",
"events_url": "<string>",
"assignees_url": "<string>",
"branches_url": "<string>",
"tags_url": "<string>",
"blobs_url": "<string>",
"git_tags_url": "<string>",
"git_refs_url": "<string>",
"trees_url": "<string>",
"statuses_url": "<string>",
"languages_url": "<string>",
"stargazers_url": "<string>",
"contributors_url": "<string>",
"subscribers_url": "<string>",
"subscription_url": "<string>",
"commits_url": "<string>",
"git_commits_url": "<string>",
"comments_url": "<string>",
"issue_comment_url": "<string>",
"contents_url": "<string>",
"compare_url": "<string>",
"merges_url": "<string>",
"archive_url": "<string>",
"downloads_url": "<string>",
"issues_url": "<string>",
"pulls_url": "<string>",
"milestones_url": "<string>",
"notifications_url": "<string>",
"labels_url": "<string>",
"releases_url": "<string>",
"deployments_url": "<string>",
"created_at": "2021-10-28T16:05:50Z",
"updated_at": "2021-10-28T16:05:50Z",
"pushed_at": "2021-10-28T16:05:50Z",
"git_url": "<string>",
"ssh_url": "<string>",
"clone_url": "<string>",
"svn_url": "<string>",
"homepage": "<string>",
"size": 45895,
"stargazers_count": 2,
"watchers_count": 1,
"language": "<string>",
"has_issues": false,
"has_projects": true,
"has_downloads": true,
"has_wiki": true,
"has_pages": false,
"has_discussions": false,
"forks_count": 1,
"mirror_url": null,
"archived": false,
"disabled": false,
"open_issues_count": 2,
"license": {
"key": "<string>",
"name": "<string>",
"spdx_id": "<string>",
"url": "<string>",
"node_id": "<string>"
},
"allow_forking": true,
"is_template": false,
"web_commit_signoff_required": false,
"topics": [],
"visibility": "<string>",
"forks": 0,
"open_issues": 2,
"watchers": 2,
"default_branch": "<string>"
}
},
"base": {
"label": "<string>",
"ref": "<string>",
"sha": "<string>",
"user": {
"login": "<string>",
"id": 7331741,
"node_id": "<string>",
"avatar_url": "<string>",
"gravatar_id": "<string>",
"url": "<string>",
"html_url": "<string>",
"followers_url": "<string>",
"following_url": "<string>",
"gists_url": "<string>",
"starred_url": "<string>",
"subscriptions_url": "<string>",
"organizations_url": "<string>",
"repos_url": "<string>",
"events_url": "<string>",
"received_events_url": "<string>",
"type": "<string>",
"user_view_type": "<string>",
"site_admin": false
},
"repo": {
"id": 56676314,
"node_id": "<string>",
"name": "<string>",
"full_name": "<string>",
"private": false,
"owner": {
"login": "<string>",
"id": 794815,
"node_id": "<string>",
"avatar_url": "<string>",
"gravatar_id": "<string>",
"url": "<string>",
"html_url": "<string>",
"followers_url": "<string>",
"following_url": "<string>",
"gists_url": "<string>",
"starred_url": "<string>",
"subscriptions_url": "<string>",
"organizations_url": "<string>",
"repos_url": "<string>",
"events_url": "<string>",
"received_events_url": "<string>",
"type": "<string>",
"user_view_type": "<string>",
"site_admin": false
},
"html_url": "<string>",
"description": "<string>",
"fork": false,
"url": "<string>",
"forks_url": "<string>",
"keys_url": "<string>",
"collaborators_url": "<string>",
"teams_url": "<string>",
"hooks_url": "<string>",
"issue_events_url": "<string>",
"events_url": "<string>",
"assignees_url": "<string>",
"branches_url": "<string>",
"tags_url": "<string>",
"blobs_url": "<string>",
"git_tags_url": "<string>",
"git_refs_url": "<string>",
"trees_url": "<string>",
"statuses_url": "<string>",
"languages_url": "<string>",
"stargazers_url": "<string>",
"contributors_url": "<string>",
"subscribers_url": "<string>",
"subscription_url": "<string>",
"commits_url": "<string>",
"git_commits_url": "<string>",
"comments_url": "<string>",
"issue_comment_url": "<string>",
"contents_url": "<string>",
"compare_url": "<string>",
"merges_url": "<string>",
"archive_url": "<string>",
"downloads_url": "<string>",
"issues_url": "<string>",
"pulls_url": "<string>",
"milestones_url": "<string>",
"notifications_url": "<string>",
"labels_url": "<string>",
"releases_url": "<string>",
"deployments_url": "<string>",
"created_at": "2021-10-28T16:05:50Z",
"updated_at": "2021-10-28T16:05:50Z",
"pushed_at": "2021-10-28T16:05:50Z",
"git_url": "<string>",
"ssh_url": "<string>",
"clone_url": "<string>",
"svn_url": "<string>",
"homepage": "<string>",
"size": 72713,
"stargazers_count": 1264,
"watchers_count": 41,
"language": "<string>",
"has_issues": true,
"has_projects": false,
"has_downloads": true,
"has_wiki": true,
"has_pages": false,
"has_discussions": true,
"forks_count": 750,
"mirror_url": null,
"archived": false,
"disabled": false,
"open_issues_count": 102,
"license": {
"key": "<string>",
"name": "<string>",
"spdx_id": "<string>",
"url": "<string>",
"node_id": "<string>"
},
"allow_forking": true,
"is_template": false,
"web_commit_signoff_required": false,
"topics": [],
"visibility": "<string>",
"forks": 418,
"open_issues": 382,
"watchers": 220,
"default_branch": "<string>"
}
},
"_links": {
"self": {
"href": "<string>"
},
"html": {
"href": "<string>"
},
"issue": {
"href": "<string>"
},
"comments": {
"href": "<string>"
},
"review_comments": {
"href": "<string>"
},
"review_comment": {
"href": "<string>"
},
"commits": {
"href": "<string>"
},
"statuses": {
"href": "<string>"
}
},
"author_association": "<string>",
"auto_merge": null,
"active_lock_reason": null
}
]
Workflow Library Example
List Pull Requests with Github and Send Results Via Email