Microsoft API Pagination Python API Docs | dltHub
Build a Microsoft API Pagination-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
REST API pagination in Microsoft involves breaking large data sets into smaller chunks using methods like offset, cursor, or token-based pagination. Essential techniques include specifying limit and page parameters in API requests. Pagination helps manage large data efficiently. The REST API base URL is https://api.fabric.microsoft.com/v1 and all requests require a Bearer token for authentication.
dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading Microsoft API Pagination data in under 10 minutes.
What data can I load from Microsoft API Pagination?
Here are some of the endpoints you can load from Microsoft API Pagination:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| workspaces | /workspaces | GET | value | Lists workspaces; paginated responses include value, continuationToken, continuationUri |
| items | /workspaces/{workspaceId}/items | GET | value | Lists items in a workspace; paginated |
| users | /users | GET | value | Lists users; paginated |
| lakehouses | /lakehouses | GET | value | Lists lakehouses; paginated |
| notebooks | /notebooks | GET | value | Lists notebooks; paginated |
| reports | /reports | GET | value | Lists reports; paginated |
| (Other GET endpoints follow same pattern: most Fabric list endpoints return { "value": [...], "continuationToken": "...", "continuationUri": "..."}) |
How do I authenticate with the Microsoft API Pagination API?
Requests use Azure AD OAuth 2.0 Bearer tokens (Authorization: Bearer <access_token>) obtained for Fabric scopes; include the header Authorization: Bearer on every request.
1. Get your credentials
- Register an app in Azure AD (Azure Portal > App registrations). 2) Add required API permissions / scopes for Microsoft Fabric REST APIs (e.g., user_impersonation or specific Fabric scopes) and grant admin consent. 3) Create a client secret (or use certificate) under Certificates & secrets. 4) Acquire an access token via OAuth2 client credentials or auth code flow against Azure AD token endpoint (POST to https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token) with client_id, client_secret, scope. 5) Use returned access_token as Bearer token in Authorization header.
2. Add them to .dlt/secrets.toml
[sources.microsoft_api_pagination_source] token = "your_bearer_token_here"
dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.
How do I set up and run the pipeline?
Set up a virtual environment and install dlt:
uv venv && source .venv/bin/activate uv pip install "dlt[workspace]"
1. Install the dlt AI Workbench:
dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex
This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →
2. Install the rest-api-pipeline toolkit:
dlt ai toolkit rest-api-pipeline install
This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →
3. Start LLM-assisted coding:
Use /find-source to load data from the Microsoft API Pagination API into DuckDB.
The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.
4. Run the pipeline:
python microsoft_api_pagination_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline microsoft_api_pagination_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset microsoft_api_pagination_data The duckdb destination used duckdb:/microsoft_api_pagination.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline microsoft_api_pagination_pipeline show
This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.
Python pipeline example
This example loads workspaces and items from the Microsoft API Pagination API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:
import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def microsoft_api_pagination_source(token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.fabric.microsoft.com/v1", "auth": { "type": "bearer", "token": token, }, }, "resources": [ {"name": "workspaces", "endpoint": {"path": "workspaces", "data_selector": "value"}}, {"name": "items", "endpoint": {"path": "workspaces/{workspaceId}/items", "data_selector": "value"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="microsoft_api_pagination_pipeline", destination="duckdb", dataset_name="microsoft_api_pagination_data", ) load_info = pipeline.run(microsoft_api_pagination_source()) print(load_info)
To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.
How do I query the loaded data?
Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.
Python (pandas DataFrame):
import dlt data = dlt.pipeline("microsoft_api_pagination_pipeline").dataset() sessions_df = data.workspaces.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM microsoft_api_pagination_data.workspaces LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("microsoft_api_pagination_pipeline").dataset() data.workspaces.df().head()
See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.
What destinations can I load Microsoft API Pagination data to?
dlt supports loading into any of these destinations — only the destination parameter changes:
| Destination | Example value |
|---|---|
| DuckDB (local, default) | "duckdb" |
| PostgreSQL | "postgres" |
| BigQuery | "bigquery" |
| Snowflake | "snowflake" |
| Redshift | "redshift" |
| Databricks | "databricks" |
| Filesystem (S3, GCS, Azure) | "filesystem" |
Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.
Next steps
Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:
data-exploration— Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.dlthub-runtime— Deploy, schedule, and monitor your pipeline in production.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install
Was this page helpful?
Community Hub
Need more dlt context for Microsoft API Pagination?
Request dlt skills, commands, AGENT.md files, and AI-native context.