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 Workspaces API

A workspace is where you create repositories, collaborate onyour code, and organize different streams of work in your BitbucketCloud account. Workspaces replace the use of teams and users in APIcalls.

Bitbucket Pipelines Workspaces 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 Workspaces. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 19 operations across 16 paths, and defines 33 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.

19 operations 16 paths 33 schemas 1 DELETE16 GET1 POST1 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 Workspaces 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 19

Across 16 paths, the API surfaces 19 operations — 1 DELETE, 16 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Workspaces 19

A workspace is where you create repositories, collaborate on your code, and organize different streams of work in your Bitbucket Cloud account. Workspaces replace the use of teams…

GET
/user/permissions/workspacesdeprecated
List workspaces for the current user
2 params → 200401
GET
/user/workspaces
List workspaces for the current user
2 params → 200400401
GET
/user/workspaces/{workspace}/permission
Get user permission on a workspace
1 param → 200401403
GET
/workspacesdeprecated
List workspaces for user
3 params → 200401
GET
/workspaces/{workspace}
Get a workspace
1 param → 200404
GET
/workspaces/{workspace}/hooks
List webhooks for a workspace
1 param → 200403404
POST
/workspaces/{workspace}/hooks
Create a webhook for a workspace
1 param → 201403404
DELETE
/workspaces/{workspace}/hooks/{uid}
Delete a webhook for a workspace
2 params → 204403404
GET
/workspaces/{workspace}/hooks/{uid}
Get a webhook for a workspace
2 params → 200404
PUT
/workspaces/{workspace}/hooks/{uid}
Update a webhook for a workspace
2 params → 200403404
GET
/workspaces/{workspace}/members
List users in a workspace
1 param → 200400401
GET
/workspaces/{workspace}/members/{member}
Get user membership for a workspace
2 params → 200401404
GET
/workspaces/{workspace}/permissions
List user permissions in a workspace
2 params → 200401
GET
/workspaces/{workspace}/permissions/repositories
List all repository permissions for a workspace
3 params → 200403
GET
/workspaces/{workspace}/permissions/repositories/{repo_slug}
List a repository permissions for a workspace
4 params → 200403
GET
/workspaces/{workspace}/projects
List projects in a workspace
1 param → 200404
GET
/workspaces/{workspace}/projects/{project_key}
Get a project for a workspace
2 params → 200401403404
GET
/workspaces/{workspace}/pullrequests/{selected_user}
List workspace pull requests for a user
3 params → 200404
GET
/workspaces/{workspace}/settings/gpg/public-key
Get the workspace system GPG public key(s)
1 param → 200401403404

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are paginated_repository_permissions (6 properties), paginated_workspace_memberships (6 properties), paginated_workspaces (6 properties), paginated_webhook_subscriptions (6 properties). Each schema is shown below with its type and property counts.

link
object
A link to a resource related to this object.
2 properties
project
pullrequest_endpoint
object
3 properties
base_commit
paginated_webhook_subscriptions
object
A paginated list of webhook subscriptions
6 properties
paginated_projects
object
A paginated list of projects
6 properties
account
branch
paginated_pullrequests
object
A paginated list of pullrequests.
6 properties
paginated_workspaces
object
A paginated list of workspaces.
6 properties
participant
team_links
ref
object
A ref object, representing a branch or tag in a repository.
4 properties 1 required
pullrequest
user
author
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
paginated_repository_permissions
object
A paginated list of repository permissions.
6 properties
workspace_membership
committer
paginated_workspace_memberships
object
A paginated list of workspace memberships.
6 properties
account_links
object
Links related to an Account.
1 property
paginated_workspace_access
object
A paginated list of workspace permissions.
6 properties
webhook_subscription
user_links
commit
repository
repository_permission
object
A user's permission for a given repository.
4 properties 1 required
team
workspace
workspace_base
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
workspace_access

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bitbucket-pipelines-workspaces-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 Workspaces 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.