Reports - Get Reports In Group

Returns a list of reports from the specified workspace.

Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Note: Paginated reports (rdl) don’t have a dataset. As a result, in the API response for paginated reports, the dataset ID value isn’t displayed.

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

URI Parameters

Name In Required Type Description
groupId
path True
  • string
uuid

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/reports

Sample Response

{
  "value": [
    {
      "datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "id": "5b218778-e7a5-4d73-8187-f10824047715",
      "name": "SalesMarketing",
      "webUrl": "https://app.powerbi.com/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/reports/5b218778-e7a5-4d73-8187-f10824047715",
      "embedUrl": "https://app.powerbi.com/reportEmbed?reportId=5b218778-e7a5-4d73-8187-f10824047715&groupId=f089354e-8366-4e18-aea3-4cb4a3a50b48"
    }
  ]
}

Definitions

EndorsementDetails

Power BI endorsement details

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.

Reports

Odata response wrapper for a Power BI report collection

ReportUser

A Power BI user access right entry for report

ReportUserAccessRight

Access rights user has for the report (Permission level)

SensitivityLabel

Artifact sensitivity label info

EndorsementDetails

Power BI endorsement details

Name Type Description
certifiedBy
  • string

The user that certified the artifact

endorsement
  • string

The endorsement status

PrincipalType

The principal type

Name Type Description
App
  • string

Service principal type

Group
  • string

Group principal type

None
  • string

None principal type, used for whole organization level access.

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. Available only for reports created after June 2019.

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

users

The Report User Access Details. This value will be empty. It will be removed from the payload response in an upcoming release. To retrieve user information on an artifact, please consider using the Get Report User as Admin APIs, or the PostWorkspaceInfo API with the getArtifactUser parameter.

webUrl
  • string

The report web url

Reports

Odata response wrapper for a Power BI report collection

Name Type Description
odata.context
  • string

OData context

value

The report collection

ReportUser

A Power BI user access right entry for report

Name Type Description
displayName
  • string

Display name of the principal

emailAddress
  • string

Email address of the user

graphId
  • string

Identifier of the principal in Microsoft Graph. Only available for admin APIs.

identifier
  • string

Identifier of the principal

principalType

The principal type

reportUserAccessRight

Access rights user has for the report (Permission level)

ReportUserAccessRight

Access rights user has for the report (Permission level)

Name Type Description
None
  • string

No permission to content in report

Owner
  • string

Grants Read, Write and Reshare access to content in report

Read
  • string

Grants Read access to content in report

ReadReshare
  • string

Grants Read and Reshare access to content in report

ReadWrite
  • string

Grants Read and Write access to content in report

SensitivityLabel

Artifact sensitivity label info

Name Type Description
labelId
  • string

The sensitivity label ID