---
title: "List users in a workspace"
method: GET
path: "/workspaces/{workspace}/members"
tags: ["Workspaces"]
---

# List users in a workspace

`GET /workspaces/{workspace}/members`

Returns all members of the requested workspace.

This endpoint additionally supports [filtering](/cloud/bitbucket/rest/intro/#filtering) by
email address, if called by a workspace administrator, integration or workspace access
token. This is done by adding the following query string parameter:

* `q=user.email IN ("user1@org.com","user2@org.com")`

When filtering by email, you can query up to 90 addresses at a time.
Note that the query parameter values need to be URL escaped, so the final query string
should be:

* `q=user.email%20IN%20(%22user1@org.com%22,%22user2@org.com%22)`

Email addresses that you filter by (and only these email addresses) can be included in the
response using the `fields` query parameter:

* `&fields=+values.user.email` - add the `email` field to the default `user` response object
* `&fields=values.user.email,values.user.account_id` - only return user email addresses and
account IDs

Once again, all query parameter values must be URL escaped.

## Response `200`

The list of users that are part of a workspace.

- PaginatedWorkspaceMemberships — A paginated list of workspace memberships.
  - `size` integer — 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.
  - `page` integer — Page number of the current results. This is an optional element that is not provided in all responses.
  - `pagelen` integer — 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.
  - `next` string, 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.
  - `previous` string, 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.
  - `values` WorkspaceMembership[]
    - `type` string, required
    - `links` object
      - `self` object — A link to a resource related to this object.
        - `href` string, uri
        - `name` string
    - `user` Account — An account object.
      - `type` string, required
      - `links` AccountLinks — Links related to an Account.
        - `avatar` Link — A link to a resource related to this object.
          - `href` string, uri
          - `name` string
      - `created_on` string, date-time
      - `display_name` string
      - `uuid` string
    - `workspace` Workspace — A Bitbucket workspace. Workspaces are used to organize repositories.
      - `type` string, required
      - `links` object
        - `avatar` object — A link to a resource related to this object.
          - `href` string, uri
          - `name` string
        - `html` object — A link to a resource related to this object.
          - `href` string, uri
          - `name` string
        - `members` object — A link to a resource related to this object.
          - `href` string, uri
          - `name` string
        - `owners` object — A link to a resource related to this object.
          - `href` string, uri
          - `name` string
        - `projects` object — A link to a resource related to this object.
          - `href` string, uri
          - `name` string
        - `repositories` object — A link to a resource related to this object.
          - `href` string, uri
          - `name` string
        - `snippets` object — A link to a resource related to this object.
          - `href` string, uri
          - `name` string
        - `self` object — A link to a resource related to this object.
          - `href` string, uri
          - `name` string
      - `uuid` string — The workspace's immutable id.
      - `name` string — The name of the workspace.
      - `slug` string — The short label that identifies this workspace.
      - `is_private` boolean — Indicates whether the workspace is publicly accessible, or whether it is private to the members and consequently only visible to members.
      - `is_personal` boolean — Indicates whether the workspace belongs to an individual user.
      - `is_privacy_enforced` boolean — Indicates whether the workspace enforces private content, or whether it allows public content.
      - `forking_mode` 'allow_forks' | 'internal_only' — Controls the rules for forking repositories within this workspace. * **allow_forks**: unrestricted forking * **internal_only**: prevents forking of private repositories outside the workspace or to public repositories
      - `created_on` string, date-time
      - `updated_on` string, date-time

## Other responses

- `400` — When more than 90 emails were provided when querying by email.
- `401` — The request wasn't authenticated.

---

[API](https://skmtc.net/bitbucket/apis/bitbucket-api.md) · [All operations](https://skmtc.net/bitbucket/apis/bitbucket-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bitbucket/bitbucket-api/versions/4ec8bd2515c5/schema)
