ATatlassian
Workspaces

List user permissions in a workspace

Changed on

Returns the list of members in a workspace and their permission levels. Permission 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 by permission by adding the following query string parameters:

  • q=permission="owner"
get/workspaces/{workspace}/permissions

Request

  • Base URL
    https://api.bitbucket.org/2.0
  • URL
    https://api.bitbucket.org/2.0/workspaces/{workspace}/permissions
  • Auth
    • OAuth 2
      Authorization code: https://bitbucket.org/site/oauth2/authorize
      Token URL: https://bitbucket.org/site/oauth2/access_token scopes: account
    • or HTTP basic
    • or API key in header Authorization

Query parameters

qstring

Query string to narrow down the response as per filtering and sorting.

Response

The list of users that are part of a workspace, along with their permission.

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.

Changes

  • 8c7911c0a910Revision changes
    • info

      added the optional property ///// to the response with the status

  • d344164ecb11Revision changes
    • warning

      removed the optional property ///// from the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status