Groups - Get Group

Reference

Service:: Power BI REST APIs

API Version:: v1.0

Returns a specified workspace.

Permissions

This API call can be called by a service principal profile. For more information see: Service principal profiles in Power BI Embedded.

Required Scope

Workspace.Read.All or Workspace.ReadWrite.All

Limitations

User permissions for workspaces take time to get updated and may not be immediately available when using API calls. To refresh user permissions, use the Refresh User Permissions API call.

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}

URI Parameters

Name	In	Required	Type	Description
groupId	path	True	string uuid	The workspace ID

Responses

Name	Type	Description
200 OK	Group	OK

Examples

Example

Sample request

GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48

Sample response

Status code:: 200

{
  "id": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
  "isReadOnly": false,
  "isOnDedicatedCapacity": true,
  "capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2",
  "defaultDatasetStorageFormat": "Small",
  "name": "Sample Group 1"
}

Definitions

Name	Description
AzureResource	A response detailing a user-owned Azure resource such as a Log Analytics workspace.
DefaultDatasetStorageFormat	The default dataset storage format in the group
Group	A Power BI group

AzureResource

A response detailing a user-owned Azure resource such as a Log Analytics workspace.

Name	Type	Description
id	string	An identifier for the resource within Power BI.
resourceGroup	string	The resource group within the subscription where the resource resides.
resourceName	string	The name of the resource.
subscriptionId	string	The Azure subscription where the resource resides.

DefaultDatasetStorageFormat

The default dataset storage format in the group

Name	Type	Description
Large	string	Large dataset storage format
Small	string	Small dataset storage format

Group

A Power BI group

Name	Type	Description
capacityId	string	The capacity ID
dataflowStorageId	string	The Power BI dataflow storage account ID
defaultDatasetStorageFormat	DefaultDatasetStorageFormat	The default dataset storage format in the workspace. Returned only when `isOnDedicatedCapacity` is `true`
id	string	The workspace ID
isOnDedicatedCapacity	boolean	Whether the group is assigned to a dedicated capacity
isReadOnly	boolean	Whether the group is read-only
logAnalyticsWorkspace	AzureResource	The Log Analytics workspace assigned to the group. This is returned only when retrieving a single group.
name	string	The group name

Share via