Sign in

v2

latestOpenAPI 3.0.02026-08-013312111.4 MB
Workspaces

List workspaces for the current user

This endpoint is deprecated. Please use the supported alternatives:

  • List workspaces for user
  • Get user permission on a workspace

Returns an object for each workspace the caller is a member of, and their effective role - the highest level of privilege the caller has. If a user is a member of multiple groups with distinct roles, only the highest level is returned.

Permissions can be:

  • owner
  • collaborator
  • member

The collaborator role is being removed from the Bitbucket Cloud API. For more information, see the deprecation announcement.

When you move your administration from Bitbucket Cloud to admin.atlassian.com, the following fields on workspace_membership will no longer be present: last_accessed and added_on. See the deprecation announcement.

Results may be further filtered or sorted by workspace or permission by adding the following query string parameters:

  • q=workspace.slug="bbworkspace1" or q=permission="owner"
  • sort=workspace.slug

Note that the query parameter values need to be URL escaped so that = would become %3D.

get/user/permissions/workspaces

Query parameters

qstring

Query string to narrow down the response. See filtering and sorting for details.

sortstring

Name of a response property to sort results. See filtering and sorting for details.

Response

All of the workspace memberships for the authenticated user.

sizeinteger

Total number of objects in the response. This is an optional element that is not provided in all responses, as it can be expensive to compute.

pageinteger

Page number of the current results. This is an optional element that is not provided in all responses.

pageleninteger

Current number of objects on the existing page. The default value is 10 with 100 being the maximum allowed value. Individual APIs may enforce different values.

nextstring uri

Link to the next page if it exists. The last page of a collection does not have this value. Use this link to navigate the result set and refrain from constructing your own URLs.

previousstring uri

Link to previous page if it exists. A collections first page does not have this value. This is an optional element that is not provided in all responses. Some result sets strictly support forward navigation and never provide previous links. Clients must anticipate that backwards navigation is not always available. Use this link to navigate the result set and refrain from constructing your own URLs.