SharePoint 2013 REST API Python API Docs | dltHub
Build a SharePoint 2013 REST API-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
SharePoint 2013 REST API documentation is available at https://spshell.blogspot.com/2015/01/sharepoint-2013-rest-api-reference.html. REST APIs use standard HTTP methods for CRUD operations. REST is a lightweight, stateless architectural style. The REST API base URL is https://{site_url}/_api and OAuth Bearer token (or page/add-in context via SP.RequestExecutor); POST write requests require X-RequestDigest when not using OAuth add-in flows..
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 SharePoint 2013 REST API data in under 10 minutes.
What data can I load from SharePoint 2013 REST API?
Here are some of the endpoints you can load from SharePoint 2013 REST API:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| web_lists | {site_url}/_api/web/lists | GET | d.results (odata=verbose) or value (odata=nometadata) | Retrieve all lists in the web |
| list_by_title | {site_url}/_api/web/lists/GetByTitle('List Title') | GET | d | Retrieve list properties by title |
| list_items | {site_url}/_api/web/lists/GetByTitle('List Title')/items | GET | d.results (odata=verbose) or value (odata=nometadata) | Retrieve items in a list |
| list_item_by_id | {site_url}/_api/web/lists/GetByTitle('List Title')/items({item_id}) | GET | d | Retrieve a single list item by ID |
| getfile_by_serverrelativeurl | {site_url}/_api/web/getfilebyserverrelativeurl('/path/to/file') | GET | d | Get file metadata (use /$value to download) |
How do I authenticate with the SharePoint 2013 REST API API?
Remote/cloud-hosted add‑ins must include an Authorization header with a Bearer access token (Authorization: Bearer <access_token>). For non‑OAuth scenarios, POST/modify/delete operations require the X-RequestDigest header with a form digest value obtained from POST {site_url}/_api/contextinfo.
1. Get your credentials
- Register an add‑in/application in Azure AD or the SharePoint Add‑in model. 2) Configure the required permissions for the app (e.g., Sites.Read, Sites.ReadWrite). 3) Execute the OAuth flow (client‑credentials or authorization‑code) to obtain an access token for the SharePoint resource. 4) Use that access token as the Bearer token in the Authorization header for all REST calls.
2. Add them to .dlt/secrets.toml
[sources.sharepoint_2013_rest_api_source] access_token = "your_oauth_access_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 SharePoint 2013 REST API 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 sharepoint_2013_rest_api_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline sharepoint_2013_rest_api_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset sharepoint_2013_rest_api_data The duckdb destination used duckdb:/sharepoint_2013_rest_api.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline sharepoint_2013_rest_api_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 web_lists and list_items from the SharePoint 2013 REST API 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 sharepoint_2013_rest_api_source(access_token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://{site_url}/_api", "auth": { "type": "bearer", "token": access_token, }, }, "resources": [ {"name": "web_lists", "endpoint": {"path": "web/lists", "data_selector": "d.results"}}, {"name": "list_items", "endpoint": {"path": "web/lists/GetByTitle('List Title')/items", "data_selector": "d.results"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="sharepoint_2013_rest_api_pipeline", destination="duckdb", dataset_name="sharepoint_2013_rest_api_data", ) load_info = pipeline.run(sharepoint_2013_rest_api_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("sharepoint_2013_rest_api_pipeline").dataset() sessions_df = data.list_items.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM sharepoint_2013_rest_api_data.list_items LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("sharepoint_2013_rest_api_pipeline").dataset() data.list_items.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 SharePoint 2013 REST API 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 SharePoint 2013 REST API?
Request dlt skills, commands, AGENT.md files, and AI-native context.