Skip to main content
POST
/
api
/
bitbucket
/
pullrequests
/bitbucket/pullrequests
curl --request POST \
  --url https://api.anysite.io/api/bitbucket/pullrequests \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "pull": "<string>",
  "timeout": 300
}
'
[
  {
    "id": 123,
    "@type": "BitbucketPullRequest",
    "pull_title": "",
    "text": "<string>",
    "state": "",
    "is_draft": false,
    "comment_count": 0,
    "task_count": 0,
    "close_source_branch": false,
    "created_at": "",
    "updated_at": "",
    "author": {
      "@type": "BitbucketAccount",
      "uuid": "",
      "display_name": "",
      "nickname": "<string>",
      "account_id": "<string>",
      "account_type": "",
      "account_status": "<string>",
      "is_staff": false,
      "location": "<string>",
      "created_at": "<string>",
      "image": "<string>",
      "web_url": ""
    },
    "closed_by": {
      "@type": "BitbucketAccount",
      "uuid": "",
      "display_name": "",
      "nickname": "<string>",
      "account_id": "<string>",
      "account_type": "",
      "account_status": "<string>",
      "is_staff": false,
      "location": "<string>",
      "created_at": "<string>",
      "image": "<string>",
      "web_url": ""
    },
    "merge_commit_hash": "<string>",
    "reason": "",
    "source_branch": "",
    "source_commit_hash": "",
    "source_repository_alias": "<string>",
    "destination_branch": "",
    "destination_commit_hash": "",
    "destination_repository_alias": "<string>",
    "reviewers": [],
    "participants": [],
    "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 Bitbucket URL, 'workspace/repo#id', or 'workspace/repo/id'

Minimum string length: 1
Examples:

"https://bitbucket.org/atlassian/aui/pull-requests/5332"

"atlassian/aui#5332"

timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

id
integer
required
@type
string
default:BitbucketPullRequest
pull_title
string
default:""
text
string | null
state
string
default:""
is_draft
boolean
default:false
comment_count
integer
default:0
task_count
integer
default:0
close_source_branch
boolean
default:false
created_at
string
default:""
updated_at
string
default:""
author
object | null
closed_by
object | null
merge_commit_hash
string | null
reason
string
default:""
source_branch
string
default:""
source_commit_hash
string
default:""
source_repository_alias
string | null
destination_branch
string
default:""
destination_commit_hash
string
default:""
destination_repository_alias
string | null
reviewers
object[]
participants
object[]
web_url
string
default:""