/github/pulls

POST /api/github/pulls

Price: 1 credit

Get GitHub pull request details by URL or 'owner/name#number'

How to use it

Get full details of a GitHub pull request by its URL or 'owner/name#number' reference. Returns title, body, state, draft/merged flags, mergeable status, merge info, author, head/base branches, labels, assignees, requested reviewers, comment/review-comment/commit counts, additions/deletions/changed-file counts, author association, and timestamps.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• pull string required — Pull request as a GitHub URL or 'owner/name#number' (examples: "https://github.com/facebook/react/pull/10000", "facebook/react#10000"; minLength: 1)

Response

• @type string (default: "GithubPull")
• id integer required
• number integer required
• text string nullable
• state string (default: "")
• is_draft boolean (default: false)
• is_merged boolean (default: false)
• mergeable boolean nullable
• merged_at string nullable
• merged_by string nullable
• author object nullable
  • @type string (default: "GithubPullUser")
  • id integer required
  • login string required
  • image string nullable
• head object nullable
  • @type string (default: "GithubPullRef")
  • ref string required
  • sha string required
  • repo_alias string nullable
• base object nullable
  • @type string (default: "GithubPullRef")
  • ref string required
  • sha string required
  • repo_alias string nullable
• labels array (default: [])
  • @type string (default: "GithubPullLabel")
  • name string required
  • color string (default: "")
  • description string nullable
• assignees array (default: [])
  • @type string (default: "GithubPullUser")
  • id integer required
  • login string required
  • image string nullable
• requested_reviewers array (default: [])
  • @type string (default: "GithubPullUser")
  • id integer required
  • login string required
  • image string nullable
• comment_count integer (default: 0)
• review_comment_count integer (default: 0)
• commit_count integer (default: 0)
• additions integer (default: 0)
• deletions integer (default: 0)
• changed_file_count integer (default: 0)
• 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 — Pull request 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.