How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bitbucket Pipelines Pullrequests API

Pull requests are a feature that makes it easier for developersto collaborate using Bitbucket. They provide a user-friendly webinterface for discussing proposed changes before integrating theminto the official project.

Bitbucket Pipelines Pullrequests API is one of 23 APIs that Bitbucket Pipelines publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Pull Requests. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 37 operations across 24 paths, and defines 37 schemas. It is described by OpenAPI 2.0, at version 2.0.

Requests are made against the base URL https://api.bitbucket.org/2.0.

37 operations 24 paths 37 schemas 6 DELETE19 GET8 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2.0
Base URL
https://api.bitbucket.org/2.0
Authentication
basic, OAuth 2.0, API Key
Terms of Service
Resource Areas
1

Authentication & Security 3

Bitbucket Pipelines Pullrequests API declares 3 security schemes for authenticating requests. It defines a basic scheme (basic). It supports OAuth 2.0 (oauth2) using the accessCode flow, exposing 26 scopes. An API key is passed in the header as Authorization (api_key).

  • basic — Basic HTTP Authentication as per [RFC-2617](https://tools.ietf.org/html/rfc2617) (Digest not supported). Note that Basic Auth is available only with username a…
  • oauth2 — OAuth 2 as per [RFC-6749](https://tools.ietf.org/html/rfc6749).
  • api_key — API Keys can be used as Basic HTTP Authentication credentials and provide a substitute for the account's actual username and password. API Keys are only availa…

Paths & Operations 37

Across 24 paths, the API surfaces 37 operations — 6 DELETE, 19 GET, 8 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Pullrequests 37

Pull requests are a feature that makes it easier for developers to collaborate using Bitbucket. They provide a user-friendly web interface for discussing proposed changes before i…

GET
/repositories/{workspace}/{repo_slug}/commit/{commit}/pullrequests
List pull requests that contain a commit
getPullrequestsForCommit 5 params → 200404202
GET
/repositories/{workspace}/{repo_slug}/default-reviewers
List default reviewers
2 params → 200403
DELETE
/repositories/{workspace}/{repo_slug}/default-reviewers/{target_username}
Remove a user from the default reviewers
3 params → 204403404
GET
/repositories/{workspace}/{repo_slug}/default-reviewers/{target_username}
Get a default reviewer
3 params → 200403404
PUT
/repositories/{workspace}/{repo_slug}/default-reviewers/{target_username}
Add a user to the default reviewers
3 params → 200400403404
GET
/repositories/{workspace}/{repo_slug}/effective-default-reviewers
List effective default reviewers
2 params → 200403
GET
/repositories/{workspace}/{repo_slug}/pullrequests
List pull requests
3 params → 200401404
POST
/repositories/{workspace}/{repo_slug}/pullrequests
Create a pull request
3 params → 201400401
GET
/repositories/{workspace}/{repo_slug}/pullrequests/activity
List a pull request activity log
2 params → 200401404
GET
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}
Get a pull request
3 params → 200401404
PUT
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}
Update a pull request
4 params → 200400401404
GET
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/activity
List a pull request activity log
3 params → 200401404
DELETE
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/approve
Unapprove a pull request
3 params → 204400401404
POST
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/approve
Approve a pull request
3 params → 200401404
GET
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments
List comments on a pull request
3 params → 200403404
POST
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments
Create a comment on a pull request
4 params → 201403404
DELETE
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id}
Delete a comment on a pull request
4 params → 204403404
GET
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id}
Get a comment on a pull request
4 params → 200403404
PUT
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id}
Update a comment on a pull request
5 params → 200403404
DELETE
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id}/resolve
Reopen a comment thread
4 params → 204403404
POST
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/comments/{comment_id}/resolve
Resolve a comment thread
4 params → 200403404409
GET
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/commits
List commits on a pull request
3 params → 200403404
POST
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/decline
Decline a pull request
3 params → 200555
GET
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/diff
List changes in a pull request
3 params → 302
GET
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/diffstat
Get the diff stat for a pull request
3 params → 302
POST
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/merge
Merge a pull request
5 params → 200202409555
GET
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/merge/task-status/{task_id}
Get the merge task status for a pull request
4 params → 200400403409
GET
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/patch
Get the patch for a pull request
3 params → 302
DELETE
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/request-changes
Remove change request for a pull request
3 params → 204400401404
POST
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/request-changes
Request changes for a pull request
3 params → 200400401404
GET
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/statuses
List commit statuses for a pull request
5 params → 200401404
GET
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/tasks
List tasks on a pull request
6 params → 200400403404
POST
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/tasks
Create a task on a pull request
4 params → 201400403404
DELETE
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/tasks/{task_id}
Delete a task on a pull request
4 params → 204403404
GET
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/tasks/{task_id}
Get a task on a pull request
4 params → 200403404
PUT
/repositories/{workspace}/{repo_slug}/pullrequests/{pull_request_id}/tasks/{task_id}
Update a task on a pull request
5 params → 200400403404
GET
/workspaces/{workspace}/pullrequests/{selected_user}
List workspace pull requests for a user
3 params → 200404

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are task (9 properties), paginated_tasks (6 properties), paginated_accounts (6 properties), paginated_pullrequests (6 properties). Each schema is shown below with its type and property counts.

project
pullrequest_endpoint
object
3 properties
base_commit
commitstatus
paginated_default_reviewer_and_type
object
A paginated list of default reviewers with reviewer type.
6 properties
account
branch
pullrequest_task_update
object
A pullrequest task update
2 properties
paginated_pullrequests
object
A paginated list of pullrequests.
6 properties
comment_resolution
object
The resolution object for a Comment.
3 properties 1 required
task
object
A task object.
9 properties 5 required
comment
participant
team_links
pullrequest_task
ref
object
A ref object, representing a branch or tag in a repository.
4 properties 1 required
paginated_commitstatuses
object
A paginated list of commit status objects.
6 properties
pullrequest_comment
pullrequest
user
author
default_reviewer_and_type
object
Object containing a user that is a default reviewer and the type of reviewer
3 properties 1 required
error
object
Base type for most resource objects. It defines the common type element that identifies an object's type. It also identifies the element as Swagger's discrimin…
2 properties 1 required
committer
paginated_pullrequest_comments
object
A paginated list of pullrequest comments.
6 properties
account_links
object
Links related to an Account.
1 property
pullrequest_comment_task
paginated_accounts
object
A paginated list of accounts.
6 properties
pullrequest_task_create
object
A pullrequest task create
3 properties 1 required
pullrequest_merge_parameters
object
The metadata that describes a pull request merge.
4 properties 1 required
user_links
commit
repository
link
object
A link to a resource related to this object.
2 properties
team
object
object
Base type for most resource objects. It defines the common type element that identifies an object's type. It also identifies the element as Swagger's discrimin…
1 property 1 required
paginated_tasks
object
A paginated list of tasks.
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bitbucket-pipelines-pullrequests-api-openapi.yml Raw ↑

Other APIs Bitbucket Pipelines publishes across the network.

Bitbucket Pipelines Addon API
Bitbucket Pipelines Branch restrictions API
Bitbucket Pipelines Branching model API
Bitbucket Pipelines Commit statuses API
Bitbucket Pipelines Commits API
Bitbucket Pipelines Deployments API
Bitbucket Pipelines Downloads API
Bitbucket Pipelines GPG API
Bitbucket Pipelines Issue tracker API
Bitbucket Pipelines Pipelines API
Bitbucket Pipelines Projects API
Bitbucket Pipelines properties API
Where this information came from

This is an independent, third-party profile of Bitbucket Pipelines Pullrequests API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.