Skip to content
forgit api docs

Get the pull request of the commit

GET
/repos/{owner}/{repo}/commits/{sha}/pull

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
owner
required
string

Owner of the repo

repo
required
string

Name of the repo

sha
required
string

SHA of the commit to get

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

PullRequest

Media type application/json

PullRequest represents a pull request

object
additions
integer format: int64
allow_maintainer_edit
boolean
assignee

User represents a user

object
active

Is user active

boolean
avatar_url

URL to the user’s avatar

string
created
string format: date-time
description

The user’s description

string
email
string format: email
followers_count

User counts

integer format: int64
following_count
integer format: int64
full_name

The user’s full name

string
html_url

URL to the user’s profile page

string
id

The user’s id

integer format: int64
is_admin

Is the user an administrator

boolean
language

User locale

string
last_login
string format: date-time
location

The user’s location

string
login

The user’s username

string
login_name

The user’s authentication sign-in name.

string
default: empty
prohibit_login

Is user login prohibited

boolean
pronouns

The user’s pronouns

string
restricted

Is user restricted

boolean
source_id

The ID of the user’s Authentication Source

integer format: int64
starred_repos_count
integer format: int64
visibility

User visibility level option: public, limited, private

string
website

The user’s website

string
assignees
Array<object>

User represents a user

object
active

Is user active

boolean
avatar_url

URL to the user’s avatar

string
created
string format: date-time
description

The user’s description

string
email
string format: email
followers_count

User counts

integer format: int64
following_count
integer format: int64
full_name

The user’s full name

string
html_url

URL to the user’s profile page

string
id

The user’s id

integer format: int64
is_admin

Is the user an administrator

boolean
language

User locale

string
last_login
string format: date-time
location

The user’s location

string
login

The user’s username

string
login_name

The user’s authentication sign-in name.

string
default: empty
prohibit_login

Is user login prohibited

boolean
pronouns

The user’s pronouns

string
restricted

Is user restricted

boolean
source_id

The ID of the user’s Authentication Source

integer format: int64
starred_repos_count
integer format: int64
visibility

User visibility level option: public, limited, private

string
website

The user’s website

string
base

PRBranchInfo information about a branch

object
label
string
ref
string
repo

Repository represents a repository

object
allow_fast_forward_only_merge
boolean
allow_merge_commits
boolean
allow_rebase
boolean
allow_rebase_explicit
boolean
allow_rebase_update
boolean
allow_squash_merge
boolean
archived
boolean
archived_at
string format: date-time
avatar_url
string
clone_url
string
created_at
string format: date-time
default_allow_maintainer_edit
boolean
default_branch
string
default_delete_branch_after_merge
boolean
default_merge_style
string
default_update_style
string
description
string
empty
boolean
external_tracker

ExternalTracker represents settings for external tracker

object
external_tracker_format

External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index.

string
external_tracker_regexp_pattern

External Issue Tracker issue regular expression

string
external_tracker_style

External Issue Tracker Number Format, either numeric, alphanumeric, or regexp

string
external_tracker_url

URL of external issue tracker.

string
external_wiki

ExternalWiki represents setting for external wiki

object
external_wiki_url

URL of external wiki.

string
fork
boolean
forks_count
integer format: int64
full_name
string
globally_editable_wiki
boolean
has_actions
boolean
has_issues
boolean
has_packages
boolean
has_projects
boolean
has_pull_requests
boolean
has_releases
boolean
has_wiki

Is the wiki enabled

boolean
has_wiki_contents

Have wiki pages ever been created

boolean
html_url
string
id
integer format: int64
ignore_whitespace_conflicts
boolean
internal
boolean
internal_tracker

InternalTracker represents settings for internal tracker

object
allow_only_contributors_to_track_time

Let only contributors track time (Built-in issue tracker)

boolean
enable_issue_dependencies

Enable dependencies for issues and pull requests (Built-in issue tracker)

boolean
enable_time_tracker

Enable time tracking (Built-in issue tracker)

boolean
language
string
languages_url
string
link
string
mirror
boolean
mirror_interval
string
mirror_updated
string format: date-time
name
string
object_format_name

ObjectFormatName of the underlying git repository

string
Allowed values: sha1 sha256
open_issues_count
integer format: int64
open_pr_counter
integer format: int64
original_url
string
owner

User represents a user

object
active

Is user active

boolean
avatar_url

URL to the user’s avatar

string
created
string format: date-time
description

The user’s description

string
email
string format: email
followers_count

User counts

integer format: int64
following_count
integer format: int64
full_name

The user’s full name

string
html_url

URL to the user’s profile page

string
id

The user’s id

integer format: int64
is_admin

Is the user an administrator

boolean
language

User locale

string
last_login
string format: date-time
location

The user’s location

string
login

The user’s username

string
login_name

The user’s authentication sign-in name.

string
default: empty
prohibit_login

Is user login prohibited

boolean
pronouns

The user’s pronouns

string
restricted

Is user restricted

boolean
source_id

The ID of the user’s Authentication Source

integer format: int64
starred_repos_count
integer format: int64
visibility

User visibility level option: public, limited, private

string
website

The user’s website

string
parent
object recursive
permissions

Permission represents a set of permissions

object
admin
boolean
pull
boolean
push
boolean
private
boolean
release_counter
integer format: int64
repo_transfer

RepoTransfer represents a pending repo transfer

object
doer

User represents a user

object
active

Is user active

boolean
avatar_url

URL to the user’s avatar

string
created
string format: date-time
description

The user’s description

string
email
string format: email
followers_count

User counts

integer format: int64
following_count
integer format: int64
full_name

The user’s full name

string
html_url

URL to the user’s profile page

string
id

The user’s id

integer format: int64
is_admin

Is the user an administrator

boolean
language

User locale

string
last_login
string format: date-time
location

The user’s location

string
login

The user’s username

string
login_name

The user’s authentication sign-in name.

string
default: empty
prohibit_login

Is user login prohibited

boolean
pronouns

The user’s pronouns

string
restricted

Is user restricted

boolean
source_id

The ID of the user’s Authentication Source

integer format: int64
starred_repos_count
integer format: int64
visibility

User visibility level option: public, limited, private

string
website

The user’s website

string
recipient

User represents a user

object
active

Is user active

boolean
avatar_url

URL to the user’s avatar

string
created
string format: date-time
description

The user’s description

string
email
string format: email
followers_count

User counts

integer format: int64
following_count
integer format: int64
full_name

The user’s full name

string
html_url

URL to the user’s profile page

string
id

The user’s id

integer format: int64
is_admin

Is the user an administrator

boolean
language

User locale

string
last_login
string format: date-time
location

The user’s location

string
login

The user’s username

string
login_name

The user’s authentication sign-in name.

string
default: empty
prohibit_login

Is user login prohibited

boolean
pronouns

The user’s pronouns

string
restricted

Is user restricted

boolean
source_id

The ID of the user’s Authentication Source

integer format: int64
starred_repos_count
integer format: int64
visibility

User visibility level option: public, limited, private

string
website

The user’s website

string
teams
Array<object>

Team represents a team in an organization

object
can_create_org_repo
boolean
description
string
id
integer format: int64
includes_all_repositories
boolean
name
string
organization

Organization represents an organization

object
avatar_url
string
created
string format: date-time
description
string
email
string
full_name
string
id
integer format: int64
location
string
name
string
repo_admin_change_team_access
boolean
username

Deprecated

string
visibility
string
website
string
permission
string
Allowed values: none read write admin owner
units
Array<string>
units_map
object
key
additional properties
string
size
integer format: int64
ssh_url
string
stars_count
integer format: int64
template
boolean
topics
Array<string>
updated_at
string format: date-time
url
string
watchers_count
integer format: int64
website
string
wiki_branch
string
wiki_clone_url
string
wiki_ssh_url
string
repo_id
integer format: int64
sha
string
body
string
changed_files
integer format: int64
closed_at
string format: date-time
comments
integer format: int64
created_at
string format: date-time
deletions
integer format: int64
diff_url
string
draft
boolean
due_date
string format: date-time
flow
integer format: int64
head

PRBranchInfo information about a branch

object
label
string
ref
string
repo

Repository represents a repository

object
allow_fast_forward_only_merge
boolean
allow_merge_commits
boolean
allow_rebase
boolean
allow_rebase_explicit
boolean
allow_rebase_update
boolean
allow_squash_merge
boolean
archived
boolean
archived_at
string format: date-time
avatar_url
string
clone_url
string
created_at
string format: date-time
default_allow_maintainer_edit
boolean
default_branch
string
default_delete_branch_after_merge
boolean
default_merge_style
string
default_update_style
string
description
string
empty
boolean
external_tracker

ExternalTracker represents settings for external tracker

object
external_tracker_format

External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index.

string
external_tracker_regexp_pattern

External Issue Tracker issue regular expression

string
external_tracker_style

External Issue Tracker Number Format, either numeric, alphanumeric, or regexp

string
external_tracker_url

URL of external issue tracker.

string
external_wiki

ExternalWiki represents setting for external wiki

object
external_wiki_url

URL of external wiki.

string
fork
boolean
forks_count
integer format: int64
full_name
string
globally_editable_wiki
boolean
has_actions
boolean
has_issues
boolean
has_packages
boolean
has_projects
boolean
has_pull_requests
boolean
has_releases
boolean
has_wiki

Is the wiki enabled

boolean
has_wiki_contents

Have wiki pages ever been created

boolean
html_url
string
id
integer format: int64
ignore_whitespace_conflicts
boolean
internal
boolean
internal_tracker

InternalTracker represents settings for internal tracker

object
allow_only_contributors_to_track_time

Let only contributors track time (Built-in issue tracker)

boolean
enable_issue_dependencies

Enable dependencies for issues and pull requests (Built-in issue tracker)

boolean
enable_time_tracker

Enable time tracking (Built-in issue tracker)

boolean
language
string
languages_url
string
link
string
mirror
boolean
mirror_interval
string
mirror_updated
string format: date-time
name
string
object_format_name

ObjectFormatName of the underlying git repository

string
Allowed values: sha1 sha256
open_issues_count
integer format: int64
open_pr_counter
integer format: int64
original_url
string
owner

User represents a user

object
active

Is user active

boolean
avatar_url

URL to the user’s avatar

string
created
string format: date-time
description

The user’s description

string
email
string format: email
followers_count

User counts

integer format: int64
following_count
integer format: int64
full_name

The user’s full name

string
html_url

URL to the user’s profile page

string
id

The user’s id

integer format: int64
is_admin

Is the user an administrator

boolean
language

User locale

string
last_login
string format: date-time
location

The user’s location

string
login

The user’s username

string
login_name

The user’s authentication sign-in name.

string
default: empty
prohibit_login

Is user login prohibited

boolean
pronouns

The user’s pronouns

string
restricted

Is user restricted

boolean
source_id

The ID of the user’s Authentication Source

integer format: int64
starred_repos_count
integer format: int64
visibility

User visibility level option: public, limited, private

string
website

The user’s website

string
parent
object recursive
permissions

Permission represents a set of permissions

object
admin
boolean
pull
boolean
push
boolean
private
boolean
release_counter
integer format: int64
repo_transfer

RepoTransfer represents a pending repo transfer

object
doer

User represents a user

object
active

Is user active

boolean
avatar_url

URL to the user’s avatar

string
created
string format: date-time
description

The user’s description

string
email
string format: email
followers_count

User counts

integer format: int64
following_count
integer format: int64
full_name

The user’s full name

string
html_url

URL to the user’s profile page

string
id

The user’s id

integer format: int64
is_admin

Is the user an administrator

boolean
language

User locale

string
last_login
string format: date-time
location

The user’s location

string
login

The user’s username

string
login_name

The user’s authentication sign-in name.

string
default: empty
prohibit_login

Is user login prohibited

boolean
pronouns

The user’s pronouns

string
restricted

Is user restricted

boolean
source_id

The ID of the user’s Authentication Source

integer format: int64
starred_repos_count
integer format: int64
visibility

User visibility level option: public, limited, private

string
website

The user’s website

string
recipient

User represents a user

object
active

Is user active

boolean
avatar_url

URL to the user’s avatar

string
created
string format: date-time
description

The user’s description

string
email
string format: email
followers_count

User counts

integer format: int64
following_count
integer format: int64
full_name

The user’s full name

string
html_url

URL to the user’s profile page

string
id

The user’s id

integer format: int64
is_admin

Is the user an administrator

boolean
language

User locale

string
last_login
string format: date-time
location

The user’s location

string
login

The user’s username

string
login_name

The user’s authentication sign-in name.

string
default: empty
prohibit_login

Is user login prohibited

boolean
pronouns

The user’s pronouns

string
restricted

Is user restricted

boolean
source_id

The ID of the user’s Authentication Source

integer format: int64
starred_repos_count
integer format: int64
visibility

User visibility level option: public, limited, private

string
website

The user’s website

string
teams
Array<object>

Team represents a team in an organization

object
can_create_org_repo
boolean
description
string
id
integer format: int64
includes_all_repositories
boolean
name
string
organization

Organization represents an organization

object
avatar_url
string
created
string format: date-time
description
string
email
string
full_name
string
id
integer format: int64
location
string
name
string
repo_admin_change_team_access
boolean
username

Deprecated

string
visibility
string
website
string
permission
string
Allowed values: none read write admin owner
units
Array<string>
units_map
object
key
additional properties
string
size
integer format: int64
ssh_url
string
stars_count
integer format: int64
template
boolean
topics
Array<string>
updated_at
string format: date-time
url
string
watchers_count
integer format: int64
website
string
wiki_branch
string
wiki_clone_url
string
wiki_ssh_url
string
repo_id
integer format: int64
sha
string
html_url
string
id
integer format: int64
is_locked
boolean
labels
Array<object>

Label a label to an issue or a pr

object
color
string
description
string
exclusive
boolean
id
integer format: int64
is_archived
boolean
name
string
url
string
merge_base
string
merge_commit_sha
string
mergeable
boolean
merged
boolean
merged_at
string format: date-time
merged_by

User represents a user

object
active

Is user active

boolean
avatar_url

URL to the user’s avatar

string
created
string format: date-time
description

The user’s description

string
email
string format: email
followers_count

User counts

integer format: int64
following_count
integer format: int64
full_name

The user’s full name

string
html_url

URL to the user’s profile page

string
id

The user’s id

integer format: int64
is_admin

Is the user an administrator

boolean
language

User locale

string
last_login
string format: date-time
location

The user’s location

string
login

The user’s username

string
login_name

The user’s authentication sign-in name.

string
default: empty
prohibit_login

Is user login prohibited

boolean
pronouns

The user’s pronouns

string
restricted

Is user restricted

boolean
source_id

The ID of the user’s Authentication Source

integer format: int64
starred_repos_count
integer format: int64
visibility

User visibility level option: public, limited, private

string
website

The user’s website

string
milestone

Milestone milestone is a collection of issues on one repository

object
closed_at
string format: date-time
closed_issues
integer format: int64
created_at
string format: date-time
description
string
due_on
string format: date-time
id
integer format: int64
open_issues
integer format: int64
state

StateType issue state type

string
title
string
updated_at
string format: date-time
number
integer format: int64
patch_url
string
pin_order
integer format: int64
requested_reviewers
Array<object>

User represents a user

object
active

Is user active

boolean
avatar_url

URL to the user’s avatar

string
created
string format: date-time
description

The user’s description

string
email
string format: email
followers_count

User counts

integer format: int64
following_count
integer format: int64
full_name

The user’s full name

string
html_url

URL to the user’s profile page

string
id

The user’s id

integer format: int64
is_admin

Is the user an administrator

boolean
language

User locale

string
last_login
string format: date-time
location

The user’s location

string
login

The user’s username

string
login_name

The user’s authentication sign-in name.

string
default: empty
prohibit_login

Is user login prohibited

boolean
pronouns

The user’s pronouns

string
restricted

Is user restricted

boolean
source_id

The ID of the user’s Authentication Source

integer format: int64
starred_repos_count
integer format: int64
visibility

User visibility level option: public, limited, private

string
website

The user’s website

string
requested_reviewers_teams
Array<object>

Team represents a team in an organization

object
can_create_org_repo
boolean
description
string
id
integer format: int64
includes_all_repositories
boolean
name
string
organization

Organization represents an organization

object
avatar_url
string
created
string format: date-time
description
string
email
string
full_name
string
id
integer format: int64
location
string
name
string
repo_admin_change_team_access
boolean
username

Deprecated

string
visibility
string
website
string
permission
string
Allowed values: none read write admin owner
units
Array<string>
units_map
object
key
additional properties
string
review_comments

Number of review comments made on the diff of a PR review (not including comments on commits or issues in a PR)

integer format: int64
state

StateType issue state type

string
title
string
updated_at
string format: date-time
url
string
user

User represents a user

object
active

Is user active

boolean
avatar_url

URL to the user’s avatar

string
created
string format: date-time
description

The user’s description

string
email
string format: email
followers_count

User counts

integer format: int64
following_count
integer format: int64
full_name

The user’s full name

string
html_url

URL to the user’s profile page

string
id

The user’s id

integer format: int64
is_admin

Is the user an administrator

boolean
language

User locale

string
last_login
string format: date-time
location

The user’s location

string
login

The user’s username

string
login_name

The user’s authentication sign-in name.

string
default: empty
prohibit_login

Is user login prohibited

boolean
pronouns

The user’s pronouns

string
restricted

Is user restricted

boolean
source_id

The ID of the user’s Authentication Source

integer format: int64
starred_repos_count
integer format: int64
visibility

User visibility level option: public, limited, private

string
website

The user’s website

string
Example 
{
  "assignee": {
    "login_name": "empty"
  },
  "assignees": [
    {
      "login_name": "empty"
    }
  ],
  "base": {
    "repo": {
      "object_format_name": "sha1",
      "owner": {
        "login_name": "empty"
      },
      "repo_transfer": {
        "doer": {
          "login_name": "empty"
        },
        "recipient": {
          "login_name": "empty"
        },
        "teams": [
          {
            "permission": "none",
            "units": [
              "repo.code",
              "repo.issues",
              "repo.ext_issues",
              "repo.wiki",
              "repo.pulls",
              "repo.releases",
              "repo.projects",
              "repo.ext_wiki"
            ],
            "units_map": {
              "repo.actions": "none",
              "repo.code": "read",
              "repo.ext_issues": "none",
              "repo.ext_wiki": "none",
              "repo.issues": "write",
              "repo.packages": "none",
              "repo.projects": "none",
              "repo.pulls": "owner",
              "repo.releases": "none",
              "repo.wiki": "admin"
            }
          }
        ]
      }
    }
  },
  "head": {
    "repo": {
      "object_format_name": "sha1",
      "owner": {
        "login_name": "empty"
      },
      "repo_transfer": {
        "doer": {
          "login_name": "empty"
        },
        "recipient": {
          "login_name": "empty"
        },
        "teams": [
          {
            "permission": "none",
            "units": [
              "repo.code",
              "repo.issues",
              "repo.ext_issues",
              "repo.wiki",
              "repo.pulls",
              "repo.releases",
              "repo.projects",
              "repo.ext_wiki"
            ],
            "units_map": {
              "repo.actions": "none",
              "repo.code": "read",
              "repo.ext_issues": "none",
              "repo.ext_wiki": "none",
              "repo.issues": "write",
              "repo.packages": "none",
              "repo.projects": "none",
              "repo.pulls": "owner",
              "repo.releases": "none",
              "repo.wiki": "admin"
            }
          }
        ]
      }
    }
  },
  "labels": [
    {
      "color": "00aabb",
      "exclusive": false,
      "is_archived": false
    }
  ],
  "merged_by": {
    "login_name": "empty"
  },
  "requested_reviewers": [
    {
      "login_name": "empty"
    }
  ],
  "requested_reviewers_teams": [
    {
      "permission": "none",
      "units": [
        "repo.code",
        "repo.issues",
        "repo.ext_issues",
        "repo.wiki",
        "repo.pulls",
        "repo.releases",
        "repo.projects",
        "repo.ext_wiki"
      ],
      "units_map": {
        "repo.actions": "none",
        "repo.code": "read",
        "repo.ext_issues": "none",
        "repo.ext_wiki": "none",
        "repo.issues": "write",
        "repo.packages": "none",
        "repo.projects": "none",
        "repo.pulls": "owner",
        "repo.releases": "none",
        "repo.wiki": "admin"
      }
    }
  ],
  "user": {
    "login_name": "empty"
  }
}

404

Section titled “ 404 ”

APINotFound is a not found error response

Media type application/json
object
errors
Array<string>
message
string
url
string
Example generated 
{
  "errors": [
    "example"
  ],
  "message": "example",
  "url": "example"
}