Dashboards - Get Dashboards In Group

Returns a list of dashboards from the specified workspace.

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

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

URI Parameters

Name In Required Type Description
groupId
path True
  • string

The workspace id

Responses

Name Type Description
200 OK

OK

Examples

example

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
      "displayName": "SalesMarketing",
      "embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af&groupId=f089354e-8366-4e18-aea3-4cb4a3a50b48",
      "isReadOnly": false
    }
  ]
}

Definitions

Dashboard

A Power BI dashboard

ODataResponse[List[Dashboard]]

Odata response wrapper for a Power BI dashboard 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

ODataResponse[List[Dashboard]]

Odata response wrapper for a Power BI dashboard collection

Name Type Description
odata.context
  • string

OData context

value

The dashboard collection