List pull requests files

GET

/repos/{owner}/{repo}/pulls/{pull_number}/files

Lists the files in a specified pull request.

[!NOTE] Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.

This endpoint supports the following custom media types. For more information, see “Media types.”

• application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type.
• application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text.
• application/vnd.github.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html.
• application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.

API method documentation

Parameters

Path Parameters

owner

required

string

The account owner of the repository. The name is not case sensitive.

repo

required

string

The name of the repository without the .git extension. The name is not case sensitive.

pull_number

required

integer

The number that identifies the pull request.

Query Parameters

per_page

integer

default: 30

The number of results per page (max 100). For more information, see “Using pagination in the REST API.”

page

integer

default: 1

The page number of the results to fetch. For more information, see “Using pagination in the REST API.”

Responses

200

Response

Media type application/json

Array<object>

Diff Entry

Diff Entry

object

sha

required

string

nullable

filename

required

string

status

required

string

Allowed values: added removed modified renamed copied changed unchanged

additions

required

integer

deletions

required

integer

changes

required

integer

blob_url

required

string format: uri

raw_url

required

string format: uri

contents_url

required

string format: uri

patch

string

previous_filename

string

Examples

Example default

[
  {
    "sha": "bbcd538c8e72b8c175046e27cc8f907076331401",
    "filename": "file1.txt",
    "status": "added",
    "additions": 103,
    "deletions": 21,
    "changes": 124,
    "blob_url": "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt",
    "raw_url": "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt",
    "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e",
    "patch": "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test"
  }
]

Headers

Link

string

Example

<https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; rel="last"

422

Validation failed, or the endpoint has been spammed.

Media type application/json

Validation Error

Validation Error

object

message

required

string

documentation_url

required

string

errors

Array<object>

object

resource

string

field

string

message

string

code

required

string

index

integer

value

One of:

string

string

nullable

integer

integer

nullable

Array<string>

Array<string>

nullable

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "errors": [
    {
      "resource": "example",
      "field": "example",
      "message": "example",
      "code": "example",
      "index": 1,
      "value": [
        "example"
      ]
    }
  ]
}

500

Internal Error

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

503

Service unavailable

Media type application/json

object

code

string

message

string

documentation_url

string

Example ^generated

{
  "code": "example",
  "message": "example",
  "documentation_url": "example"
}