Groups - Get Groups

Returns a list of workspaces the user has access to.

Note: Users that have been recently added to a group may not have their new group immediately available, see Refresh user permissions.

Required scope: Workspace.Read.All or Workspace.ReadWrite.All
To set the permissions scope, see Register an app.

GET https://api.powerbi.com/v1.0/myorg/groups
GET https://api.powerbi.com/v1.0/myorg/groups?$filter={$filter}&$top={$top}&$skip={$skip}

URI Parameters

Name In Required Type Description
$filter
query
  • string

Filters the results, based on a boolean condition

$skip
query
  • integer
int32

Skips the first n results

$top
query
  • integer
int32

Returns only the first n results

Responses

Name Type Description
200 OK

OK

Examples

example
example with filter

example

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "sample group"
    },
    {
      "id": "3d9b93c6-7b6d-4801-a491-1738910904fd",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "marketing group"
    },
    {
      "id": "a2f89923-421a-464e-bf4c-25eab39bb09f",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "contoso",
      "dataflowStorageId": "d692ae06-708c-485e-9987-06ff0fbdbb1f"
    }
  ]
}

example with filter

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups?$filter=$filter=contains(name,'marketing')%20or%20name%20eq%20'contoso'

Sample Response

{
  "value": [
    {
      "id": "3d9b93c6-7b6d-4801-a491-1738910904fd",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "marketing group"
    },
    {
      "id": "a2f89923-421a-464e-bf4c-25eab39bb09f",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "contoso",
      "dataflowStorageId": "d692ae06-708c-485e-9987-06ff0fbdbb1f"
    }
  ]
}

Definitions

Dashboard

A Power BI dashboard. Below is a list of properties that may be returned for a dashboard. Only a subset of the properties will be returned depending on the API called, the caller permissions and the availability of the data in the Power BI database.

Dataflow

The metadata of a dataflow. Below is a list of properties that may be returned for a dataflow. Only a subset of the properties will be returned depending on the API called, the caller permissions and the availability of the data in the Power BI database.

Dataset

A Power BI dataset. Below is a list of properties that may be returned for a dataset. Only a subset of the properties will be returned depending on the API called, the caller permissions and the availability of the data in the Power BI database.

DatasourceUsage

Datasource usage

DependentDataflow

A Power BI Dependent dataflow

Encryption

Encryption information for a dataset

EncryptionStatus

Dataset encryption status

EndorsementDetails

Power BI endorsement details

Group

A Power BI group

Groups

Odata response wrapper for a Power BI group list

GroupUser

A Power BI user access right entry for workspace

GroupUserAccessRight

Access rights user has for the workspace

PrincipalType

The principal type

Report

A Power BI report. Below is a list of properties that may be returned for a report. Only a subset of the properties will be returned depending on the API called, the caller permissions and the availability of the data in the Power BI database.

SensitivityLabel

Artifact sensitivity label info

Tile

A Power BI tile

Workbook

A Power BI workbook

Dashboard

A Power BI dashboard. Below is a list of properties that may be returned for a dashboard. Only a subset of the properties will be returned depending on the API called, the caller permissions and the availability of the data in the Power BI database.

Name Type Description
dataClassification
  • string

The data classification tag of the dashboard

displayName
  • string

The dashboard display name

embedUrl
  • string

The dashboard embed url

id
  • string

The dashboard id

isReadOnly
  • boolean

Is ReadOnly dashboard

sensitivityLabel

The dashboard sensitivity label

tiles

The tiles that belong to the dashboard.

Dataflow

The metadata of a dataflow. Below is a list of properties that may be returned for a dataflow. Only a subset of the properties will be returned depending on the API called, the caller permissions and the availability of the data in the Power BI database.

Name Type Description
configuredBy
  • string

The dataflow owner

datasourceUsages

Datasource usages

description
  • string

The dataflow description

endorsementDetails

The dataflow endorsement details

modelUrl
  • string

A URL to the dataflow definition file (model.json)

modifiedBy
  • string

The user that modified this dataflow

modifiedDateTime
  • string

modification date time

name
  • string

The dataflow name

objectId
  • string

The dataflow id

sensitivityLabel

The dataflow sensitivity label

upstreamDataflows

Upstream Dataflows

Dataset

A Power BI dataset. Below is a list of properties that may be returned for a dataset. Only a subset of the properties will be returned depending on the API called, the caller permissions and the availability of the data in the Power BI database.

Name Type Description
ContentProviderType
  • string

The content provider type for the dataset

CreateReportEmbedURL
  • string

The dataset create report embed url

CreatedDate
  • string

DateTime of creation of this dataset

Encryption

The dataset encryption information (Only applicable when $expand is specified)

IsEffectiveIdentityRequired
  • boolean

Whether the dataset requires an effective identity. This indicates that you must send an effective identity using the GenerateToken API.

IsEffectiveIdentityRolesRequired
  • boolean

Whether RLS is defined inside the PBIX file. This indicates that you must specify a role.

IsOnPremGatewayRequired
  • boolean

Dataset requires an On-premises Data Gateway

IsRefreshable
  • boolean

Can this dataset be refreshed

QnaEmbedURL
  • string

The dataset qna embed url

addRowsAPIEnabled
  • boolean

Whether the dataset allows adding new rows

configuredBy
  • string

The dataset owner

datasourceUsages

Datasource usages

description
  • string

The dataset description

endorsementDetails

The dataset endorsement details

id
  • string

The dataset id

name
  • string

The dataset name

sensitivityLabel

The dataset sensitivity label

upstreamDataflows

Upstream Dataflows

webUrl
  • string

The dataset web url

DatasourceUsage

Datasource usage

Name Type Description
datasourceInstanceId
  • string

The datasource instance ID

DependentDataflow

A Power BI Dependent dataflow

Name Type Description
groupId
  • string

The target group id

targetDataflowId
  • string

The target dataflow id

Encryption

Encryption information for a dataset

Name Type Description
EncryptionStatus

Dataset encryption status

EncryptionStatus

Dataset encryption status

Name Type Description
InSyncWithWorkspace
  • string

Encryption is supported and is in sync with the encryption settings

NotInSyncWithWorkspace
  • string

Encryption is supported and not in sync with the encryption settings

NotSupported
  • string

Encryption is not supported for this dataset

Unknown
  • string

Unable to determine state due to dataset corruption

EndorsementDetails

Power BI endorsement details

Name Type Description
certifiedBy
  • string

The user that certified the artifact

endorsement
  • string

The endorsement status

Group

A Power BI group

Name Type Description
capacityId
  • string

The capacity id

dashboards

The dashboards that belong to the group. Available only for admin API calls.

dataflowStorageId
  • string

The Power BI dataflow storage account id

dataflows

The dataflows that belong to the group. Available only for admin API calls.

datasets

The datasets that belong to the group. Available only for admin API calls.

description
  • string

The group description. Available only for admin API calls.

id
  • string

The workspace id

isOnDedicatedCapacity
  • boolean

Is the group on dedicated capacity

isReadOnly
  • boolean

Is the group read only

name
  • string

The group name

reports

The reports that belong to the group. Available only for admin API calls.

state
  • string

The group state. Available only for admin API calls.

type
  • string

The type of group. Available only for admin API calls.

users

The users that belong to the group, and their access rights. Available only for admin API calls.

workbooks

The workbooks that belong to the group. Available only for admin API calls.

Groups

Odata response wrapper for a Power BI group list

Name Type Description
odata.context
  • string

OData context

value

The groups

GroupUser

A Power BI user access right entry for workspace

Name Type Description
displayName
  • string

Display name of the principal

emailAddress
  • string

Email address of the user

groupUserAccessRight

Access rights user has for the workspace

identifier
  • string

Object ID of the principal

principalType

The principal type

GroupUserAccessRight

Access rights user has for the workspace

Name Type Description
Admin
  • string

Grants administrator rights to workspace

Contributor
  • string

Grants Read and Explore access to content in group

Member
  • string

Grants Read, Reshare and Explore access to content in workspace

None
  • string

Removes permission to content in workspace

Viewer
  • string

Grants Read only access to content in group

PrincipalType

The principal type

Name Type Description
App
  • string

Service principal type

Group
  • string

Group principal type

User
  • string

User principal type

Report

A Power BI report. Below is a list of properties that may be returned for a report. Only a subset of the properties will be returned depending on the API called, the caller permissions and the availability of the data in the Power BI database.

Name Type Description
createdBy
  • string

The report owner

createdDateTime
  • string

The report created date time.

datasetId
  • string

The dataset id

description
  • string

The report description

embedUrl
  • string

The report embed url

endorsementDetails

The report endorsement details

id
  • string

The report id

modifiedBy
  • string

The user that modified this report

modifiedDateTime
  • string

The report modified date time.

name
  • string

The report name

reportType enum:
  • PaginatedReport

The report type

sensitivityLabel

The report sensitivity label

webUrl
  • string

The report web url

SensitivityLabel

Artifact sensitivity label info

Name Type Description
labelId
  • string

The sensitivity label ID

Tile

A Power BI tile

Name Type Description
colSpan
  • integer

number of columns a tile should span

datasetId
  • string

The dataset id. Available only for tiles created from a report or using a dataset; for example, Q&A tiles.

embedData
  • string

The tile embed data

embedUrl
  • string

The tile embed url

id
  • string

The tile id

reportId
  • string

The report id. Available only for tiles created from a report.

rowSpan
  • integer

number of rows a tile should span

title
  • string

The dashboard display name

Workbook

A Power BI workbook

Name Type Description
datasetId
  • string

DatasetId for workbooks. Only applies for workbooks that has an associated dataset.

name
  • string

The workbook name