GIgitea
repository

List a repo's pull requests

Changed on
get/repos/{owner}/{repo}/pulls

Request

  • Base URL
    https://demo.gitea.com/api/v1
  • Auth
    • HTTP basic
    • or API key in query parameter token
    • or API key in query parameter access_token
    • or API key in header Authorization
    • or API key in query parameter sudo
    • or API key in header Sudo
    • or API key in header X-GITEA-OTP
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

ownerstring required

owner of the repo

repostring required

Name of the repo

Query parameters

base_branchstring

Filter by target base branch of the pull request

state'open' | 'closed' | 'all'

State of pull request

sort'oldest' | 'recentupdate' | 'recentclose' | 'leastupdate' | 'mostcomment' | 'leastcomment' | 'priority'

Type of sort

milestoneinteger

ID of the milestone

labelsinteger[]

Label IDs

posterstring

Filter by pull request author

pageinteger

Page number of results to return (1-based)

limitinteger

Page size of results

Response

PullRequestList

additionsinteger

The number of lines added in the pull request

allow_maintainer_editboolean

Whether maintainers can edit the pull request

bodystring

The description body of the pull request

changed_filesinteger

The number of files changed in the pull request

closed_atstring date-time
commentsinteger

The number of comments on the pull request

content_versioninteger

The version of the pull request content for optimistic locking

created_atstring date-time
deletionsinteger

The number of lines deleted in the pull request

diff_urlstring

The URL to download the diff patch

draftboolean

Whether the pull request is a draft

due_datestring date-time
html_urlstring

The HTML URL to view the pull request

idinteger

The unique identifier of the pull request

is_lockedboolean

Whether the pull request conversation is locked

merge_basestring

The merge base commit SHA

merge_commit_shastring

The SHA of the merge commit

mergeableboolean

Whether the pull request can be merged

mergedboolean

Whether the pull request has been merged

merged_atstring date-time
numberinteger

The pull request number

patch_urlstring

The URL to download the patch file

pin_orderinteger

The pin order for the pull request

review_commentsinteger

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

state'open' | 'closed'

The current state of the pull request

titlestring

The title of the pull request

updated_atstring date-time
urlstring

The API URL of the pull request

Example response

[
  {
    "base": {
      "repo": {
        "repo_transfer": {
          "teams": [
            {
              "units": [
                "repo.code",
                "repo.issues",
                "repo.ext_issues",
                "repo.wiki",
                "repo.pulls",
                "repo.releases",
                "repo.projects",
                "repo.ext_wiki"
              ],
              "units_map": {
                "repo.code": "read",
                "repo.ext_issues": "none",
                "repo.ext_wiki": "none",
                "repo.issues": "write",
                "repo.projects": "none",
                "repo.pulls": "owner",
                "repo.releases": "none",
                "repo.wiki": "admin"
              }
            }
          ]
        }
      }
    },
    "head": {
      "repo": {
        "repo_transfer": {
          "teams": [
            {
              "units": [
                "repo.code",
                "repo.issues",
                "repo.ext_issues",
                "repo.wiki",
                "repo.pulls",
                "repo.releases",
                "repo.projects",
                "repo.ext_wiki"
              ],
              "units_map": {
                "repo.code": "read",
                "repo.ext_issues": "none",
                "repo.ext_wiki": "none",
                "repo.issues": "write",
                "repo.projects": "none",
                "repo.pulls": "owner",
                "repo.releases": "none",
                "repo.wiki": "admin"
              }
            }
          ]
        }
      }
    },
    "labels": [
      {
        "color": "00aabb"
      }
    ],
    "requested_reviewers_teams": [
      {
        "units": [
          "repo.code",
          "repo.issues",
          "repo.ext_issues",
          "repo.wiki",
          "repo.pulls",
          "repo.releases",
          "repo.projects",
          "repo.ext_wiki"
        ],
        "units_map": {
          "repo.code": "read",
          "repo.ext_issues": "none",
          "repo.ext_wiki": "none",
          "repo.issues": "write",
          "repo.projects": "none",
          "repo.pulls": "owner",
          "repo.releases": "none",
          "repo.wiki": "admin"
        }
      }
    ]
  }
]

Changes

  • 7ef50c4c527fRevision changes
    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

  • 4ff3544d6eb3Revision changes
    • info

      added the new optional query request parameter base_branch

    • info

      added the new optional query request parameter poster

    • info

      added the non-success response with the status