/gitee/repos/pulls

POST /api/gitee/repos/pulls

Price: 20 credits

List the pull requests of a Gitee repository, filtered by state, branches, author, reviewer, tester, labels, milestone and update time

How to use it

The default state is `all`, so set `state` to `open` or `merged` to narrow it. Pass a returned `number` with the repository to gitee/pulls for a single pull request.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• repo string required — Gitee repository (examples: "chinabugotech/hutool", "https://gitee.com/mindspore/mindspore"; minLength: 1)
• state string — Pull request state (default: "all"; one of: "all", "open", "closed", "merged")
• base string nullable — Target branch name (examples: "master", "v5-master"; minLength: 1)
• author string nullable — Login of the pull request author (examples: "looly"; minLength: 1)
• labels string nullable — Label name (examples: "lgtm"; minLength: 1)
• head string nullable — Source branch name (examples: "v7-dev", "master"; minLength: 1)
• assignee string nullable — Login of a reviewer of the pull request (examples: "looly"; minLength: 1)
• tester string nullable — Login of a tester of the pull request (examples: "eva_wu"; minLength: 1)
• milestone_number integer nullable — Milestone number (examples: 215985; min: 1)
• updated_after integer nullable — Only pull requests updated at or after this unix timestamp (examples: 1735689600)
• direction string — Order by creation time (default: "desc"; one of: "desc", "asc")
• count integer required — Max number of results (min: 1)

Response

• @type string (default: "GiteePull")
• id integer required
• number integer required
• pull_title string nullable
• text string nullable
• state string nullable
• author object nullable
  • @type string (default: "GiteeUserStub")
  • id integer required
  • alias string required
  • name string nullable
  • image string nullable
  • url string nullable
  • user_type string nullable
• reviewers array (default: [])
  • @type string (default: "GiteePullReviewer")
  • id integer required
  • alias string required
  • name string nullable
  • image string nullable
  • url string nullable
  • is_assignee boolean nullable
  • is_code_owner boolean nullable
  • is_accepted boolean nullable
• testers array (default: [])
  • @type string (default: "GiteePullReviewer")
  • id integer required
  • alias string required
  • name string nullable
  • image string nullable
  • url string nullable
  • is_assignee boolean nullable
  • is_code_owner boolean nullable
  • is_accepted boolean nullable
• required_reviewer_count integer nullable
• required_tester_count integer nullable
• labels array (default: [])
  • @type string (default: "GiteeLabel")
  • id integer required
  • name string required
  • color string nullable
• milestone object nullable
  • @type string (default: "GiteeMilestone")
  • number integer required
  • milestone_title string nullable
  • state string nullable
  • description string nullable
  • open_issue_count integer nullable
  • closed_issue_count integer nullable
  • url string nullable
  • due_at integer nullable
  • created_at integer nullable
  • updated_at integer nullable
• head object nullable
  • @type string (default: "GiteePullRef")
  • ref string required
  • label string nullable
  • sha string nullable
  • repo_id integer nullable
  • repo_alias string nullable
  • user_alias string nullable
• base object nullable
  • @type string (default: "GiteePullRef")
  • ref string required
  • label string nullable
  • sha string nullable
  • repo_id integer nullable
  • repo_alias string nullable
  • user_alias string nullable
• is_draft boolean nullable
• is_locked boolean nullable
• is_mergeable boolean nullable
• is_private boolean nullable
• is_closing_related_issue boolean nullable
• is_pruning_branch boolean nullable
• url string nullable
• created_at integer nullable
• updated_at integer nullable
• closed_at integer nullable
• merged_at integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No public Gitee repository under that owner/name, or no milestone with that number in it Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.