Share via

Groups - Create Group

Service:
Power BI REST APIs
API Version:
v1.0

Creates a new workspace.

Permissions

Required Scope

Workspace.ReadWrite.All 

POST https://api.powerbi.com/v1.0/myorg/groups
With optional parameters: 
POST https://api.powerbi.com/v1.0/myorg/groups?workspaceV2={workspaceV2}

URI Parameters

Name In Required Type Description
workspaceV2
 query

boolean

(Preview feature) Whether to create a workspace. The only supported value is true.

Request Body

Name Required Type Description
name True

string

The name of the newly created group

Responses

Name Type Description
200 OK

Group

OK

Examples

Create a workspace example
Example

Create a workspace example

Sample request

POST https://api.powerbi.com/v1.0/myorg/groups?workspaceV2=True
Request Body
{
  "name": "sample workspace"
}

Sample response

Status code:
200 
{
  "value": [
    {
      "id": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
      "isOnDedicatedCapacity": false,
      "name": "sample workspace"
    }
  ]
}

Example

Sample request

POST https://api.powerbi.com/v1.0/myorg/groups
Request Body
{
  "name": "sample group"
}

Sample response

Status code:
200 
{
  "value": [
    {
      "id": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "sample group"
    }
  ]
}

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
GroupCreationRequest

A Power BI request to create a new group

AzureResource

Object

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

Name Type Description
id

string (uuid)

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 (uuid)

The Azure subscription where the resource resides.

DefaultDatasetStorageFormat

Enumeration

The default dataset storage format in the group

Value Description
Small

Small dataset storage format
Large

Large dataset storage format

Group

Object

A Power BI group

Name Type Description
capacityId

string (uuid)

The capacity ID
dataflowStorageId

string (uuid)

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 (uuid)

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

GroupCreationRequest

Object

A Power BI request to create a new group

Name Type Description
name

string

The name of the newly created group