Skip to main content
POST
/
api
/
github
/
pulls
/github/pulls
curl --request POST \
  --url https://api.anysite.io/api/github/pulls \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "pull": "<string>",
  "timeout": 300
}
'
[
  {
    "id": 123,
    "number": 123,
    "@type": "@github_pull",
    "title": "",
    "text": "<string>",
    "state": "",
    "is_draft": false,
    "is_merged": false,
    "mergeable": true,
    "merged_at": "<string>",
    "merged_by": "<string>",
    "author": {
      "id": 123,
      "login": "<string>",
      "@type": "@github_pull_user",
      "image": "<string>"
    },
    "head": {
      "ref": "<string>",
      "sha": "<string>",
      "@type": "@github_pull_ref",
      "repo_alias": "<string>"
    },
    "base": {
      "ref": "<string>",
      "sha": "<string>",
      "@type": "@github_pull_ref",
      "repo_alias": "<string>"
    },
    "labels": [],
    "assignees": [],
    "requested_reviewers": [],
    "comment_count": 0,
    "review_comment_count": 0,
    "commit_count": 0,
    "additions": 0,
    "deletions": 0,
    "changed_file_count": 0,
    "author_association": "",
    "created_at": "",
    "updated_at": "",
    "closed_at": "<string>",
    "web_url": ""
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
pull
string
required

Pull request as a GitHub URL or 'owner/name#number'

Minimum string length: 1
Examples:

"https://github.com/facebook/react/pull/10000"

"facebook/react#10000"

timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

id
integer
required
number
integer
required
@type
string
default:@github_pull
title
string
default:""
text
string | null
state
string
default:""
is_draft
boolean
default:false
is_merged
boolean
default:false
mergeable
boolean | null
merged_at
string | null
merged_by
string | null
author
GithubPullUser · object
head
GithubPullRef · object
base
GithubPullRef · object
labels
GithubPullLabel · object[]
assignees
GithubPullUser · object[]
requested_reviewers
GithubPullUser · object[]
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 | null
web_url
string
default:""