External DocumentationTo learn more, visit the GitHub documentation.
Parameters
| Parameter | Description |
|---|---|
| Owner | The organization or person who owns the repository. github.com// |
| Pull Number | Pull number can be found in the pull request’s URL. |
| Repo | Name of the repository owned by the owner. github.com// |
| Reviewers | A comma-separated list of user logins that will be requested. |
| Team Reviewers | A comma-separated list of team slugs that will be requested. |
Example Output
{
"url": "<string>",
"id": 181332542,
"node_id": "<string>",
"html_url": "<string>",
"diff_url": "<string>",
"patch_url": "<string>",
"issue_url": "<string>",
"number": 109,
"state": "<string>",
"locked": false,
"title": "<string>",
"user": {
"login": "<string>",
"id": 162688144,
"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": null,
"assignees": [],
"requested_reviewers": [
{
"login": "<string>",
"id": 41961179,
"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": 66379444,
"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": [],
"labels": [],
"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": 45043443,
"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": 332350910,
"node_id": "<string>",
"name": "<string>",
"full_name": "<string>",
"private": true,
"owner": {
"login": "<string>",
"id": 71115300,
"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": null,
"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": null,
"size": 4843,
"stargazers_count": 4,
"watchers_count": 1,
"language": "<string>",
"has_issues": true,
"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": 0,
"license": null,
"allow_forking": false,
"is_template": false,
"web_commit_signoff_required": false,
"topics": [],
"visibility": "<string>",
"forks": 1,
"open_issues": 6,
"watchers": 3,
"default_branch": "<string>"
}
},
"base": {
"label": "<string>",
"ref": "<string>",
"sha": "<string>",
"user": {
"login": "<string>",
"id": 46751798,
"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": 276990490,
"node_id": "<string>",
"name": "<string>",
"full_name": "<string>",
"private": true,
"owner": {
"login": "<string>",
"id": 33414662,
"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": null,
"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": null,
"size": 1398,
"stargazers_count": 2,
"watchers_count": 1,
"language": "<string>",
"has_issues": true,
"has_projects": true,
"has_downloads": true,
"has_wiki": true,
"has_pages": false,
"has_discussions": false,
"forks_count": 0,
"mirror_url": null,
"archived": false,
"disabled": false,
"open_issues_count": 4,
"license": null,
"allow_forking": false,
"is_template": false,
"web_commit_signoff_required": false,
"topics": [],
"visibility": "<string>",
"forks": 2,
"open_issues": 7,
"watchers": 1,
"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
}