---
title: "List user groups for a workspace"
method: GET
path: "/workspaces/{workspaceId}/groups"
tags: ["workspaces"]
---

# List user groups for a workspace

`GET /workspaces/{workspaceId}/groups`

## Request

- Base URL: `https://budibase.app/api/public/v1`
- URL: `https://budibase.app/api/public/v1/workspaces/{workspaceId}/groups`
- Auth: API key in header `x-budibase-api-key`

Returns groups that grant role or builder access to this workspace. Requires a global admin API key and the user groups and expanded public API features. Both development and production workspace IDs are accepted. SCIM-managed groups are included but their memberships cannot be changed through the public user API.

## Path parameters

- `workspaceId` string, required

## Response `200`

Returns the groups associated with the workspace.

- UserGroupList
  - `data` object[], required
    - `_id` string, required: The group ID to use in a user's userGroups array.
    - `name` string, required: The group's name.
    - `isDefault` boolean, required: Whether new users are automatically assigned to this group.
    - `managedByScim` boolean, required: Whether the group is managed by SCIM. Memberships in these groups cannot be changed through the public user API.

## Changes

- **2026-10-15** `f96a603b373e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/budibase/apis/budibase-api/changes/workspaces/:workspaceId/groups/get.md)

---

[API](https://skmtc.dev/budibase/apis/budibase-api.md) - [All operations](https://skmtc.dev/budibase/apis/budibase-api/llms.txt) - [OpenAPI document](https://skmtc.dev/budibase/apis/budibase-api/revisions/f96a603b373e?raw)