Dataflows - Get Dataflows

Returns a list of all dataflows from the specified workspace.

Permissions

This API call can be called by a service principal profile. For more information see: Service principal profiles in Power BI Embedded.

Required Scope

Dataflow.ReadWrite.All or Dataflow.Read.All

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

URI Parameters

Name In Required Type Description
groupId
path True

string

uuid

The workspace ID

Responses

Name Type Description
200 OK

Dataflows

OK

Examples

Example

Sample request

GET https://api.powerbi.com/v1.0/myorg/groups/a2f89923-421a-464e-bf4c-25eab39bb09f/dataflows

Sample response

{
  "value": [
    {
      "objectId": "bd32e5c0-363f-430b-a03b-5535a4804b9b",
      "name": "AdventureWorks",
      "description": "Our Adventure Works",
      "modelUrl": "https://MyDataflowStorageAccount.dfs.core.windows.net/powerbi/contoso/AdventureWorks/model.json"
    }
  ]
}

Definitions

Name Description
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.

Dataflows

OData response wrapper for a dataflow metadata list

DataflowUser

A Power BI user access right entry for a dataflow

DataflowUserAccessRight

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

PrincipalType

The principal type

ServicePrincipalProfile

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

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

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

DataflowUser[]

(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.

Dataflows

OData response wrapper for a dataflow metadata list

Name Type Description
odata.context

string

value

Dataflow[]

The dataflow metadata list

DataflowUser

A Power BI user access right entry for a dataflow

Name Type Description
DataflowUserAccessRight

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

PrincipalType

The principal type

profile

ServicePrincipalProfile

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

userType

string

Type of the user.

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

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

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