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

$top
query
  • integer
int32

Returns only the first n results

$skip
query
  • integer
int32

Skips 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

Dataflow

The metadata of a dataflow

Dataset

A Power BI dataset

Encryption

Encryption information for a dataset

EncryptionStatus

Dataset encryption status

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

Tile

A Power BI tile

Tiles

Odata response wrapper for a Power BI tile collection

Dashboard

A Power BI dashboard

Name Type Description
displayName
  • string

The dashboard display name

embedUrl
  • string

The dashboard embed url

id
  • string

The dashboard id

isReadOnly
  • boolean

Is ReadOnly dashboard

tiles

The tiles associated with the dashboard

Dataflow

The metadata of a dataflow

Name Type Description
configuredBy
  • string

The dataflow owner

description
  • string

The dataflow description

modelUrl
  • string

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

name
  • string

The dataflow name

objectId
  • string

The dataflow id

Dataset

A Power BI dataset

Name Type Description
Encryption

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

IsEffectiveIdentityRequired
  • boolean

Dataset requires effective identity

IsEffectiveIdentityRolesRequired
  • boolean

Dataset requires roles

IsOnPremGatewayRequired
  • boolean

Dataset requires an On-premises Data Gateway

IsRefreshable
  • boolean

Can this dataset be refreshed

addRowsAPIEnabled
  • boolean

Whether dataset allows adding new rows

configuredBy
  • string

The dataset owner

id
  • string

The dataset id

name
  • string

The dataset name

webUrl
  • string

The dataset web url

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

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.

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

Identifier 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 write access to content in group

Member
  • string

Grants read access to content in workspace

None
  • string

Removes permission to content in workspace

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

Name Type Description
datasetId
  • string

The dataset id

embedUrl
  • string

The report embed url

id
  • string

The report id

name
  • string

The report name

webUrl
  • string

The report web url

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

Tiles

Odata response wrapper for a Power BI tile collection

Name Type Description
odata.context
  • string

OData context

value

The tile collection