/github/repos/pulls

POST /api/github/repos/pulls

Price: 20 credits

List pull requests of a GitHub repository by owner/name or repository URL

How to use it

List the pull requests of a GitHub repository by 'owner/name' slug or repository URL, filtered by state (open, closed, or all). Returns number, title, body text, state, draft and merged flags, merge timestamp, author, head and base branches, labels, author association, and timestamps for each 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 — Repository in 'owner/name' format or full GitHub URL (examples: "facebook/react", "https://github.com/torvalds/linux"; minLength: 1)
• state string — Filter pull requests by state (default: "open"; one of: "open", "closed", "all")
• count integer required — Number of pull requests to return (min: 1)

Response

• @type string (default: "GithubRepoPull")
• id integer required
• number integer required
• text string nullable
• state string (default: "")
• is_draft boolean (default: false)
• is_merged boolean (default: false)
• merged_at string nullable
• author object nullable
  • @type string (default: "GithubRepoPullAuthor")
  • id integer required
  • login string required
  • type string (default: "")
  • image string nullable
  • web_url string (default: "")
• head object nullable
  • @type string (default: "GithubRepoPullRef")
  • ref string (default: "")
  • sha string (default: "")
• base object nullable
  • @type string (default: "GithubRepoPullRef")
  • ref string (default: "")
  • sha string (default: "")
• labels array (default: [])
• author_association string (default: "")
• created_at string (default: "")
• updated_at string (default: "")
• closed_at string nullable
• web_url string (default: "")

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 — Repository not found 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.