# Microsoft Fabric Dataflow REST APIs API

> Microsoft Fabric Dataflow REST APIs API on Apizie: 15 endpoints (Returns a list of Dataflows from the specified workspace., Creates a Dataflow in the specified workspace., Returns properties of the specified Dataflow., Updates the properties of the specified Dataflow., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/analytics:microsoft-fabric-dataflow/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `analytics:microsoft-fabric-dataflow`
- Category: Analytics
- Status: byok
- Source: https://learn.microsoft.com/rest/api/fabric/
- Page: https://www.apizie.tech/api/analytics/microsoft-fabric-dataflow
- OpenAPI: https://www.apizie.tech/api/analytics/microsoft-fabric-dataflow/openapi.json



## Endpoints

### Returns a list of Dataflows from the specified workspace.
`GET https://www.apizie.tech/v1/analytics:microsoft-fabric-dataflow/items-list-dataflows` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | The workspace ID. |
| recursive | boolean | no | Lists items in a folder and its nested folders, or just a folder only. True - All items in the folder and its nested folders are listed,… |
| rootFolderId | string | no | This parameter allows users to filter items based on a specific root folder. If not provided, the workspace is used as the root folder. |
| continuationToken | string | no | A token for retrieving the next page of results. |

### Creates a Dataflow in the specified workspace.
`POST https://www.apizie.tech/v1/analytics:microsoft-fabric-dataflow/items-create-dataflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | The workspace ID. |
| body | object | yes | JSON request body |

### Returns properties of the specified Dataflow.
`GET https://www.apizie.tech/v1/analytics:microsoft-fabric-dataflow/items-get-dataflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | The workspace ID. |
| dataflowId | string | yes | The Dataflow ID. |

### Updates the properties of the specified Dataflow.
`POST https://www.apizie.tech/v1/analytics:microsoft-fabric-dataflow/items-update-dataflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | The workspace ID. |
| dataflowId | string | yes | The Dataflow ID. |
| body | object | yes | JSON request body |

### Deletes the specified Dataflow.
`POST https://www.apizie.tech/v1/analytics:microsoft-fabric-dataflow/items-delete-dataflow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | The workspace ID. |
| dataflowId | string | yes | The Dataflow ID. |
| hardDelete | boolean | no | Specifies whether to perform a hard delete. When set to `true`, the item is permanently deleted and cannot be recovered. When set to… |

### Returns the specified Dataflow public definition.
`POST https://www.apizie.tech/v1/analytics:microsoft-fabric-dataflow/items-get-dataflow-definition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | The workspace ID. |
| dataflowId | string | yes | The Dataflow ID. |
| format | string | no | The format of the dataflow public definition. |

### Overrides the definition for the specified Dataflow.
`POST https://www.apizie.tech/v1/analytics:microsoft-fabric-dataflow/items-update-dataflow-definition` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | The workspace ID. |
| dataflowId | string | yes | The Dataflow ID. |
| updateMetadata | boolean | no | When set to true and the .platform file is provided as part of the definition, the item's metadata is updated using the metadata in the… |
| body | object | yes | JSON request body |

### Retrieves all parameters defined in the specified Dataflow.
`GET https://www.apizie.tech/v1/analytics:microsoft-fabric-dataflow/items-discover-dataflow-parameters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | The workspace ID. |
| dataflowId | string | yes | The Dataflow ID. |
| continuationToken | string | no | A token for retrieving the next page of results. |

### Create a new execute schedule for a dataflow. A dataflow can create maximum 20 schedulers.
`POST https://www.apizie.tech/v1/analytics:microsoft-fabric-dataflow/background-jobs-schedule-execute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | The workspace ID. |
| dataflowId | string | yes | The item ID. |
| body | object | yes | JSON request body |

### Create a new apply changes schedule for a dataflow. A dataflow can create maximum 20 schedulers.
`POST https://www.apizie.tech/v1/analytics:microsoft-fabric-dataflow/background-jobs-schedule-apply-changes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | The workspace ID. |
| dataflowId | string | yes | The item ID. |
| body | object | yes | JSON request body |

### Run on-demand execute job instance.
`POST https://www.apizie.tech/v1/analytics:microsoft-fabric-dataflow/background-jobs-run-on-demand-execute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | The workspace ID. |
| dataflowId | string | yes | The dataflow ID. |
| body | object | no | JSON request body |

### Run on-demand apply changes job instance.
`POST https://www.apizie.tech/v1/analytics:microsoft-fabric-dataflow/background-jobs-run-on-demand-apply-changes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | The workspace ID. |
| dataflowId | string | yes | The dataflow ID. |

### Lists Gen1 dataflow upgrade readiness results in the specified workspace.
`GET https://www.apizie.tech/v1/analytics:microsoft-fabric-dataflow/upgrade-list-readiness` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | The workspace ID. |
| pageSize | integer | no | The maximum number of results per page. The value must be between 1 and 30. When omitted, the server selects the page size. |
| continuationToken | string | no | A token for retrieving the next page of results. |

### Upgrades Gen1 dataflows in the specified workspace.
`POST https://www.apizie.tech/v1/analytics:microsoft-fabric-dataflow/upgrade-upgrade-dataflows` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | The workspace ID. |
| body | object | yes | JSON request body |

### Executes a query against a dataflow and returns the result.
`POST https://www.apizie.tech/v1/analytics:microsoft-fabric-dataflow/query-execution-execute-query` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | The workspace ID. |
| dataflowId | string | yes | The Dataflow ID. |
| body | object | yes | JSON request body |

## Example
```
curl "https://www.apizie.tech/v1/analytics:microsoft-fabric-dataflow/items-list-dataflows" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Microsoft Fabric Dataflow REST APIs API?
Create a free Apizie key, then send GET https://www.apizie.tech/v1/analytics:microsoft-fabric-dataflow/items-list-dataflows with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Microsoft Fabric Dataflow REST APIs API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Microsoft Fabric Dataflow REST APIs itself also needs your own key from fabric.microsoft.com.

### Can AI agents use the Microsoft Fabric Dataflow REST APIs API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key analytics:microsoft-fabric-dataflow.

### What is the status of the Microsoft Fabric Dataflow REST APIs API?
Needs your own provider key (bring your own key)
