Sharefile Python API Docs | dltHub

ShareFile REST API is an API that uses a subset of the ODATA specification and provides access to resources such as Sessions. The REST API base URL is https://{subdomain}.{apicp}/sf/v3 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 Sharefile data in under 10 minutes.

---

What data can I load from Sharefile?

Here are some of the endpoints you can load from Sharefile:

---

How do I authenticate with the Sharefile API?

The ShareFile API uses OAuth2 for authentication. All API requests must include an Authorization header with a Bearer token, where the token is the access_token obtained through the OAuth2 flow.

1. Get your credentials

To obtain API credentials, you will need a client_id and client_secret. For the OAuth2 password grant, you also need a username and password. These are used to request an access_token from the token endpoint https://{subdomain}.sharefile.com/oauth/token by sending a POST request with grant_type=password, client_id, client_secret, username, and password in the request body with Content-Type: application/x-www-form-urlencoded.

2. Add them to .dlt/secrets.toml

Copy
[sources.sharefile_source]
access_token = "your_access_token_here"
client_id = "your_client_id_here"
client_secret = "your_client_secret_here"
username = "your_username_here"
password = "your_password_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:

Copy
uv venv && source .venv/bin/activate
uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

Copy
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:

Copy
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 Sharefile 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:

Copy
python sharefile_pipeline.py

If everything is configured correctly, you'll see output like this:

Copy
Pipeline sharefile_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset sharefile_data
The duckdb destination used duckdb:/sharefile.duckdb location to store data
Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

Copy
dlt pipeline sharefile_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 reports and sessions from the Sharefile API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def sharefile_source(access_token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://{subdomain}.{apicp}/sf/v3",
            "auth": {
                "type": "bearer",
                "access_token": access_token,
            },
        },
        "resources": [
            {"name": "reports", "endpoint": {"path": "Reports", "data_selector": "Records"}},
            {"name": "sessions", "endpoint": {"path": "Sessions"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="sharefile_pipeline",
        destination="duckdb",
        dataset_name="sharefile_data",
    )
    load_info = pipeline.run(sharefile_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):

Copy
import dlt

data = dlt.pipeline("sharefile_pipeline").dataset()
sessions_df = data.reports.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM sharefile_data.reports LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("sharefile_pipeline").dataset()
data.reports.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 Sharefile data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.

---

Troubleshooting

Authentication Failures

Authentication failures typically occur if the access_token is invalid, expired, or missing from the Authorization header. Ensure that the access_token is correctly obtained through the OAuth2 flow and included in the Authorization: Bearer {access_token} header for all API requests. If using the password grant, verify that the client_id, client_secret, username, and password are correct when requesting the token.

API Host and Subdomain Issues

The ShareFile API uses an account-specific host pattern: https://{subdomain}.{apicp}/sf/v3. Incorrect subdomain or apicp values will lead to connection errors. Ensure these values are correctly configured based on your ShareFile account details, which are typically returned along with the access_token during the OAuth2 process.

Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.

---

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.

Copy
dlt ai toolkit data-exploration install
dlt ai toolkit dlthub-runtime install

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack