Admin - Groups GetGroupsAsAdmin

Returns a list of workspaces for the organization.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required Scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 50 requests per hour, per tenant. This call will also time out after 30 seconds to prevent adverse effect on the Power BI service.

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

URI Parameters

Name In Required Type Description
$top
query True
  • integer
int32

Returns only the first n results. This parameter is mandatory and must be in the range of 1-5000.

$expand
query
  • string

Accepts a comma-separated list of data types, which will be expanded inline in the response. Supports users, reports, dashboards, datasets, dataflows, and workbooks.

$filter
query
  • string

Filters the results based on a boolean condition

$skip
query
  • integer
int32

Skips the first n results. Use with top to fetch results beyond the first 5000.

Responses

Name Type Description
200 OK

OK

Examples

Get deleted workspaces example. Only applicable for workspaces in the new workspace experience.
Get orphaned workspaces example. Only applicable for workspaces in the new workspace experience.
Get workspaces with their 'dashboards' expanded example
Get workspaces with their 'datasets' expanded example
Get workspaces with their 'datasets' expanded example. Only applicable for workspaces in the new workspace experience.
Get workspaces with their 'reports' expanded example
Get workspaces with their 'users' expanded example. Only applicable for workspaces in the new workspace experience.
Get workspaces with their 'workbooks' expanded example

Get deleted workspaces example. Only applicable for workspaces in the new workspace experience.

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$filter=state eq 'Deleted'&$top=100

Sample Response

{
  "value": [
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "Sample Group 2",
      "description": "Deleted sample group",
      "type": "Workspace",
      "state": "Deleted"
    }
  ]
}

Get orphaned workspaces example. Only applicable for workspaces in the new workspace experience.

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=users&$filter=(not users/any()) or (not users/any(u: u/groupUserAccessRight eq Microsoft.PowerBI.ServiceContracts.Api.GroupUserAccessRight'Admin'))&$top=100

Sample Response

{
  "value": [
    {
      "id": "d5caa808-8c91-400a-911d-06af08dbcc31",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "Orphaned Group",
      "description": "Sample orphan group",
      "type": "Workspace",
      "state": "Active",
      "users": []
    }
  ]
}

Get workspaces with their 'dashboards' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=dashboards&$top=100

Sample Response

{
  "value": [
    {
      "id": "94E57E92-CEE2-486D-8CC8-218C97200579",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "capacityMigrationStatus": "Migrated",
      "description": "shorter description",
      "type": "Workspace",
      "state": "Removing",
      "name": "a",
      "dashboards": [
        {
          "id": "4668133c-ae3f-42fb-ad7c-214a8623280c",
          "displayName": "SQlAzure-Refresh.pbix",
          "isReadOnly": false
        },
        {
          "id": "a8f18ca7-63e8-4220-bc1c-f576ec180b98",
          "displayName": "cdvc",
          "isReadOnly": false
        }
      ]
    }
  ]
}

Get workspaces with their 'datasets' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=datasets&$top=100

Sample Response

{
  "value": [
    {
      "id": "94E57E92-CEE2-486D-8CC8-218C97200579",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "capacityMigrationStatus": "Migrated",
      "description": "shorter description",
      "type": "Workspace",
      "state": "Removing",
      "name": "a",
      "datasets": [
        {
          "id": "8ce96c50-85a0-4db3-85c6-7ccc3ed46523",
          "name": "SQlAzure-Refresh",
          "addRowsAPIEnabled": false,
          "configuredBy": "admin@granularcontrols.ccsctp.net",
          "isRefreshable": true,
          "isEffectiveIdentityRequired": false,
          "isEffectiveIdentityRolesRequired": false,
          "isOnPremGatewayRequired": false,
          "targetStorageMode": "Abf",
          "createdDate": "2019-04-30T21:35:15.867-07:00",
          "ContentProviderType": "PbixInImportMode"
        },
        {
          "id": "7d6a4f72-1906-4e08-a469-bd6bc1ab7b69",
          "name": "NESGames",
          "addRowsAPIEnabled": false,
          "configuredBy": "admin@granularcontrols.ccsctp.net",
          "isRefreshable": true,
          "isEffectiveIdentityRequired": false,
          "isEffectiveIdentityRolesRequired": false,
          "isOnPremGatewayRequired": false,
          "targetStorageMode": "Abf",
          "createdDate": "2019-04-30T21:35:15.867-07:00",
          "ContentProviderType": "PbixInImportMode"
        }
      ]
    }
  ]
}

Get workspaces with their 'datasets' expanded example. Only applicable for workspaces in the new workspace experience.

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=datasets

Sample Response

{
  "value": [
    {
      "id": "e380d1d0-1fa6-460b-9a90-1a5c6b02414c",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "Sample Group 1",
      "description": "Sample group",
      "type": "Workspace",
      "state": "Active",
      "datasets": [
        {
          "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
          "name": "SalesMarketing",
          "addRowsAPIEnabled": false,
          "configuredBy": "john@contoso.com",
          "isRefreshable": true,
          "isEffectiveIdentityRequired": false,
          "isEffectiveIdentityRolesRequired": false,
          "isOnPremGatewayRequired": false,
          "encryption": {
            "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
            "encryptionStatus": "InSyncWithWorkspace"
          }
        }
      ]
    },
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "Sample Group 2",
      "description": "Deleted sample group",
      "type": "Workspace",
      "state": "Deleted",
      "datasets": []
    }
  ]
}

Get workspaces with their 'reports' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=reports&$top=100

Sample Response

{
  "value": [
    {
      "id": "EC1EE11F-845D-495E-82A3-9DAC2072305A",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "capacityMigrationStatus": "Migrated",
      "description": "cvcv",
      "type": "Workspace",
      "state": "Active",
      "name": "WSv2Test12",
      "reports": []
    },
    {
      "id": "94E57E92-CEE2-486D-8CC8-218C97200579",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "capacityMigrationStatus": "Migrated",
      "description": "shorter description",
      "type": "Workspace",
      "state": "Removing",
      "name": "a",
      "reports": [
        {
          "id": "5DBA60B0-D9A7-42AE-B12C-6D9D51E7739A",
          "reportType": "PowerBIReport",
          "name": "SQlAzure-Refresh",
          "datasetId": "8ce96c50-85a0-4db3-85c6-7ccc3ed46523"
        },
        {
          "id": "197E5C3C-D2F3-42D8-A536-875FB6D7D48C",
          "reportType": "PowerBIReport",
          "name": "NESGames",
          "datasetId": "7d6a4f72-1906-4e08-a469-bd6bc1ab7b69"
        }
      ]
    }
  ]
}

Get workspaces with their 'users' expanded example. Only applicable for workspaces in the new workspace experience.

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=users&$top=100

Sample Response

{
  "value": [
    {
      "id": "e380d1d0-1fa6-460b-9a90-1a5c6b02414c",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "Sample Group 1",
      "description": "Sample group",
      "type": "Workspace",
      "state": "Active",
      "users": [
        {
          "emailAddress": "john@contoso.com",
          "groupUserAccessRight": "Admin"
        }
      ]
    },
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "Sample Group 2",
      "description": "Deleted sample group",
      "type": "Workspace",
      "state": "Deleted",
      "users": []
    }
  ]
}

Get workspaces with their 'workbooks' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=workbooks&$top=100

Sample Response

{
  "value": [
    {
      "id": "94E57E92-CEE2-486D-8CC8-218C97200579",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "description": "shorter description",
      "type": "Workspace",
      "state": "Removing",
      "name": "a",
      "workbooks": [
        {
          "name": "My Excel sheet",
          "datasetId": "8ce96c50-85a0-4db3-85c6-7ccc3ed46523"
        }
      ]
    }
  ]
}

Definitions

AdminDashboard

A Power BI dashboard returned by Admin APIs. The API returns a subset of the following list of dashboard properties. The subset depends on the API called, caller permissions, and the availability of data in the Power BI database.

AdminDataflow

The metadata of a dataflow returned by Admin APIs. 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.

AdminDataset

A Power BI dataset returned by Admin APIs. The API returns a subset of the following list of dataset properties. The subset depends on the API called, caller permissions, and the availability of the data in the Power BI database.

AdminGroup

A Power BI group returned by admin APIs

AdminGroups

The OData response wrapper for a list of Power BI groups returned by Admin APIs

AdminReport

A Power BI report returned by Admin APIs. The API returns a subset of the following list of report properties. The subset depends on the API called, caller permissions, and the availability of data in the Power BI database.

AdminTile

A Power BI tile returned by Admin APIs.

DashboardUser

A Power BI user access right entry for a dashboard

DashboardUserAccessRight

The access right that the user has for the dashboard (permission level)

DataflowUser

A Power BI user access right entry for a dataflow

DataflowUserAccessRight

The access right that a user has for the dataflow (permission level)

DatasetUser

A Power BI user access right entry for a dataset

DatasetUserAccessRight

The access right that the user has for the dataset (permission level)

DependentDataflow

A Power BI dependent dataflow

Encryption

Encryption information for a dataset

EncryptionStatus

Dataset encryption status

GroupUser

A Power BI user with access to the workspace

GroupUserAccessRight

The access right (permission level) that a user has on the workspace

PrincipalType

The principal type

ReportUser

A Power BI user access right entry for a report

ReportUserAccessRight

The access right that the user has for the report (permission level)

ServicePrincipalProfile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

Subscription

An email subscription for a Power BI item (such as a report or a dashboard)

SubscriptionUser

A Power BI email subscription user

Workbook

A Power BI workbook

AdminDashboard

A Power BI dashboard returned by Admin APIs. The API returns a subset of the following list of dashboard properties. The subset depends on the API called, caller permissions, and the availability of data in the Power BI database.

Name Type Description
appId
  • string

The app ID, returned only if the dashboard belongs to an app

displayName
  • string

The display name of the dashboard

embedUrl
  • string

The embed URL of the dashboard

id
  • string

The dashboard ID

isReadOnly
  • boolean

Whether the dashboard is read-only

subscriptions

(Empty Value) The subscription details for a Power BI item (such as a report or a dashboard). This property will be removed from the payload response in an upcoming release. You can retrieve subscription information for a Power BI report by using the Get Report Subscriptions as Admin API call.

tiles

The tiles that belong to the dashboard

users

(Empty value) The dashboard user access details. This property will be removed from the payload response in an upcoming release. You can retrieve user information on a Power BI dashboard by using the Get Dashboard Users as Admin API call, or the PostWorkspaceInfo API call with the getArtifactUsers parameter.

webUrl
  • string

The web URL of the dashboard

AdminDataflow

The metadata of a dataflow returned by Admin APIs. 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

description
  • string

The dataflow description

modelUrl
  • string

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

modifiedBy
  • string

The user that modified the dataflow

modifiedDateTime
  • string

The date and time that the dataflow was last modified

name
  • string

The dataflow name

objectId
  • string

The dataflow ID

users

(Empty value) The dataflow user access details. This property will be removed from the payload response in an upcoming release. You can retrieve user information on a Power BI dataflow by using the Get Dataflow Users as Admin API call, or the PostWorkspaceInfo API call with the getArtifactUser parameter.

workspaceId
  • string

The dataflow workspace ID

AdminDataset

A Power BI dataset returned by Admin APIs. The API returns a subset of the following list of dataset properties. The subset depends on the API called, 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

The dataset creation date and time

Encryption

Dataset encryption information. Only applicable when $expand is specified.

IsEffectiveIdentityRequired
  • boolean

Whether the dataset requires an effective identity, which you must send in a GenerateToken API call.

IsEffectiveIdentityRolesRequired
  • boolean

Whether row-level security is defined inside the Power BI .pbix file. If so, you must specify a role.

IsOnPremGatewayRequired
  • boolean

Whether the dataset requires an on-premises data gateway

IsRefreshable
  • boolean

Whether the dataset can be refreshed

QnaEmbedURL
  • string

The dataset Q&A embed URL

addRowsAPIEnabled
  • boolean

Whether the dataset allows adding new rows

configuredBy
  • string

The dataset owner

description
  • string

The dataset description

id
  • string

The dataset ID

name
  • string

The dataset name

targetStorageMode
  • string

The dataset storage mode

upstreamDataflows

The upstream dataflows

users

(Empty value) The dataset user access details. This property will be removed from the payload response in an upcoming release. You can retrieve user information on a Power BI item (such as a report or a dashboard) by using the Get Dataset Users as Admin API, or the PostWorkspaceInfo API with the getArtifactUsers parameter.

webUrl
  • string

The web URL of the dataset

AdminGroup

A Power BI group returned by admin APIs

Name Type Description
capacityId
  • string

The capacity ID

dashboards

The dashboards that belong to the group

dataflowStorageId
  • string

The Power BI dataflow storage account ID

dataflows

The dataflows that belong to the group

datasets

The datasets that belong to the group

description
  • string

The group description

id
  • string

The workspace ID

isOnDedicatedCapacity
  • boolean

Whether the group is assigned to a dedicated capacity

isReadOnly
  • boolean

Whether the group is read-only

name
  • string

The group name

pipelineId
  • string

The deployment pipeline ID that the workspace is assigned to.

reports

The reports that belong to the group

state
  • string

The group state

type
  • string

The type of group

users

(Empty value) The users that belong to the group and their access rights. This property will be removed from the payload response in an upcoming release. You can retrieve user information on a Power BI item (such as a report or a dashboard) by using the Get Group Users As Admin API call, or the PostWorkspaceInfo API call with the getArtifactUsers parameter.

workbooks

The workbooks that belong to the group

AdminGroups

The OData response wrapper for a list of Power BI groups returned by Admin APIs

Name Type Description
odata.context
  • string

OData context

value

The list of groups

AdminReport

A Power BI report returned by Admin APIs. The API returns a subset of the following list of report properties. The subset depends on the API called, caller permissions, and the availability of data in the Power BI database.

Name Type Description
appId
  • string

The app ID, returned only if the report belongs to an app

createdBy
  • string

The report owner. Available only for reports created after June 2019.

createdDateTime
  • string

The report creation date and time

datasetId
  • string

The dataset ID of the report

description
  • string

The report description

embedUrl
  • string

The embed URL of the report

id
  • string

The report ID

modifiedBy
  • string

The last user that modified the report

modifiedDateTime
  • string

The date and time that the report was last modified

name
  • string

The name of the report

reportType enum:
  • PaginatedReport

The report type

subscriptions

(Empty Value) The subscription details for a Power BI item (such as a report or a dashboard). This property will be removed from the payload response in an upcoming release. You can retrieve subscription information for a Power BI report by using the Get Report Subscriptions as Admin API call.

users

(Empty value) The user access details for a Power BI report. This property will be removed from the payload response in an upcoming release. You can retrieve user information on a Power BI report by using the Get Report Users as Admin API call, or the PostWorkspaceInfo API call with the getArtifactUsers parameter.

webUrl
  • string

The web URL of the report

AdminTile

A Power BI tile returned by Admin APIs.

Name Type Description
colSpan
  • integer

The number of tile span columns

datasetId
  • string

The dataset ID. Available only for tiles created from a report or by using a dataset, such as Q&A tiles.

embedData
  • string

The embed data for the tile

embedUrl
  • string

The embed URL of the tile

id
  • string

The tile ID

reportId
  • string

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

rowSpan
  • integer

The number of tile span rows

title
  • string

The display name of the tile

DashboardUser

A Power BI user access right entry for a dashboard

Name Type Description
dashboardUserAccessRight

The access right that the user has for the dashboard (permission level)

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

profile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

DashboardUserAccessRight

The access right that the user has for the dashboard (permission level)

Name Type Description
None
  • string

No permission to content in dashboard

Owner
  • string

Grants Read, Write and Reshare access to content in report

Read
  • string

Grants Read access to content in dashboard

ReadCopy
  • string

Grants Read and Copy access to content in dashboard

ReadReshare
  • string

Grants Read and Reshare access to content in dashboard

ReadWrite
  • string

Grants Read and Write access to content in dashboard

DataflowUser

A Power BI user access right entry for a dataflow

Name Type Description
DataflowUserAccessRight

The access right that a user has for the dataflow (permission level)

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

profile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

DataflowUserAccessRight

The access right that a user has for the dataflow (permission level)

Name Type Description
None
  • string

Removes permission to content in dataflow

Owner
  • string

Grants Read, Write and Reshare access to content in dataflow

Read
  • string

Grants Read access to content in dataflow

ReadReshare
  • string

Grants Read and Reshare access to content in dataflow

ReadWrite
  • string

Grants Read and Write access to content in dataflow

DatasetUser

A Power BI user access right entry for a dataset

Name Type Description
datasetUserAccessRight

The access right that the user has for the dataset (permission level)

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

profile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

DatasetUserAccessRight

The access right that the user has for the dataset (permission level)

Name Type Description
None
  • string

Removes permission to the content in the dataset

Read
  • string

Grants Read access to the content in the dataset

ReadExplore
  • string

Grants Read and Explore access to the content in the dataset

ReadReshare
  • string

Grants Read and Reshare access to the content in the dataset

ReadReshareExplore
  • string

Grants Read, Reshare, and Explore access to the content in the dataset

ReadWrite
  • string

Grants Read and Write access to the content in the dataset

ReadWriteExplore
  • string

Grants Read, Write, and Explore access to the content in the dataset

ReadWriteReshare
  • string

Grants Read, Write, and Reshare access to the content in the dataset

ReadWriteReshareExplore
  • string

Grants Read, Write, Reshare, and Explore access to the content in the dataset

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 but isn't in sync with the encryption settings

NotSupported
  • string

Encryption isn't supported for this dataset

Unknown
  • string

The encryption status is unknown due to dataset corruption

GroupUser

A Power BI user with access to the workspace

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.

groupUserAccessRight

The access right (permission level) that a user has on the workspace

identifier
  • string

Identifier of the principal

principalType

The principal type

profile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

GroupUserAccessRight

The access right (permission level) that a user has on the workspace

Name Type Description
Admin
  • string

Administrator rights to workspace content

Contributor
  • string

Read and explore (ReadExplore) access to workspace content

Member
  • string

Read, reshare and explore (ReadReshareExplore) access rights to workspace content

None
  • string

No access to workspace content

Viewer
  • string

Read-only (Read) access to workspace content

PrincipalType

The principal type

Name Type Description
App
  • string

Service principal type

Group
  • string

Group principal type

None
  • string

No principal type. Use for whole organization level access.

User
  • string

User principal type

ReportUser

A Power BI user access right entry for a 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

profile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

reportUserAccessRight

The access right that the user has for the report (permission level)

ReportUserAccessRight

The access right that the 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

ReadCopy
  • string

Grants Read and Copy 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

ServicePrincipalProfile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

Name Type Description
displayName
  • string

The service principal profile name

id
  • string

The service principal profile ID

Subscription

An email subscription for a Power BI item (such as a report or a dashboard)

Name Type Description
artifactDisplayName
  • string

The name of the subscribed Power BI item (such as a report or a dashboard)

artifactId
  • string

The ID of the subscribed Power BI item (such as a report or a dashboard)

artifactType
  • string

The type of Power BI item (for example a Report, Dashboard, or Dataset)

attachmentFormat
  • string

Format of the report attached in the email subscription

endDate
  • string

The end date and time of the email subscription

frequency
  • string

The frequency of the email subscription

id
  • string

The subscription ID

isEnabled
  • boolean

Whether the email subscription is enabled

linkToContent
  • boolean

Whether a subscription link exists in the email subscription

previewImage
  • boolean

Whether a screenshot of the report exists in the email subscription

startDate
  • string

The start date and time of the email subscription

subArtifactDisplayName
  • string

The page name of the subscribed Power BI item, if it's a report.

title
  • string

The app name

users

The details of each email subscriber. When using the Get User Subscriptions As Admin API call, the returned value is an empty array (null). This property will be removed from the payload response in an upcoming release. You can retrieve subscription information on a Power BI report or dashboard by using the Get Report Subscriptions As Admin or Get Dashboard Subscriptions As Admin API calls.

SubscriptionUser

A Power BI email subscription user

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

profile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

Workbook

A Power BI workbook

Name Type Description
datasetId
  • string

The ID of the dataset associated with a workbook. Only applies if the workbook has an associated dataset.

name
  • string

The workbook name