Skip to content
Try Gitea Cloud ☁️ for 30 days → Accelerate your Development & Deploys!
This is the documentation of 1.25.5, which is no longer the latest release. See the latest release.

Get changed files for a pull request

GET
/repos/{owner}/{repo}/pulls/{index}/files
curl --request GET \
--url 'https://gitea.com/api/v1/repos/example/example/pulls/1/files?whitespace=ignore-all' \
--header 'Authorization: Basic <credentials>'
owner
required
string

Owner of the repo

repo
required
string

Name of the repo

index
required
integer format: int64

Index of the pull request to get

skip-to
string

Skip to given file

whitespace
string
Allowed values: ignore-all ignore-change ignore-eol show-all

Whitespace behavior

page
integer

Page number of results to return (1-based)

limit
integer

Page size of results

ChangedFileList

Media typeapplication/json
Array<object>

ChangedFile store information about files affected by the pull request

object
additions

The number of lines added to the file

integer format: int64
changes

The total number of changes to the file

integer format: int64
contents_url

The API URL to get the file contents

string
deletions

The number of lines deleted from the file

integer format: int64
filename

The name of the changed file

string
html_url

The HTML URL to view the file changes

string
previous_filename

The previous filename if the file was renamed

string
raw_url

The raw URL to download the file

string
status

The status of the file change (added, modified, deleted, etc.)

string
Examplegenerated
[
{
"additions": 1,
"changes": 1,
"contents_url": "example",
"deletions": 1,
"filename": "example",
"html_url": "example",
"previous_filename": "example",
"raw_url": "example",
"status": "example"
}
]
X-HasMore
boolean

True if there is another page

X-Page
integer format: int64

The current page

X-PageCount
integer format: int64

Total number of pages

X-PerPage
integer format: int64

Commits per page

X-Total
integer format: int64

Total commit count

APINotFound is a not found empty response

Media typeapplication/json