workspaces

List user groups for a workspace

Changed on

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.

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

Path parameters

workspaceIdstring required

The ID of the workspace which this request is targeting.

Response

Returns the groups associated with the workspace.

Changes