Salesforce Health Cloud Python API Docs | dltHub

Build a Salesforce Health Cloud-to-database pipeline in Python using dlt with AI harness support for Claude Code, Cursor, and Codex.

Last updated:

Salesforce Health Cloud provides RESTful APIs for healthcare data management, including FHIR-based clinical APIs and business APIs for patient care and administrative workflows. The REST API base URL is https://api.healthcloud.salesforce.com and all requests require an OAuth 2.0 Bearer token in the Authorization header.

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 add "dlt[hub]" and start loading Salesforce Health Cloud data in under 10 minutes.


What data can I load from Salesforce Health Cloud?

Here are some of the endpoints you can load from Salesforce Health Cloud:

ResourceEndpointMethodData selectorDescription
query/services/data/v{version}/query?q={soql}GETrecordsExecutes a SOQL query and returns matching records.
query_all/services/data/v{version}/queryAll?q={soql}GETrecordsExecutes a SOQL query including deleted records.
get_updated/services/data/v{version}/sobjects/{sObject}/updatedGETidsLists updated/added records for an object within a timeframe.
patients/connect/health/patientsGETRetrieves FHIR patient resource record details.
sync_status/connect/health/scores/synchronization/status/{category}GETFetches the synchronization status for a score category.

How do I authenticate with the Salesforce Health Cloud API?

Salesforce REST APIs require an OAuth 2.0 access token passed in the Authorization header using the 'Bearer' scheme (e.g., 'Authorization: Bearer <access_token>').

1. Get your credentials

  1. Log in to your Salesforce org as an administrator. 2. Navigate to Setup, search for App Manager, and click New Connected App. 3. Provide the app name, API name, and contact email. 4. Under API (Enable OAuth Settings), select Enable OAuth Settings. 5. Set a Callback URL (e.g., https://login.salesforce.com/services/oauth2/success or a local callback). 6. Select necessary OAuth scopes (e.g., 'API' or 'Full access'). 7. Save the app. 8. Once saved, click Manage Consumer Details to view your generated Consumer Key (Client ID) and Consumer Secret (Client Secret). Note: Salesforce may email a verification code to the registered email to display these secrets.

2. Add them to .dlt/secrets.toml

[sources.salesforce_health_cloud_source] client_id = "your_consumer_key_here" client_secret = "your_consumer_secret_here" instance_url = "https://your-instance.my.salesforce.com"

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 init uv add "dlt[hub]"

1. Install the dlt AI harness:

uv run dlthub 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:

uv run dlthub ai toolkit install rest-api-pipeline

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 Salesforce Health Cloud 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:

uv run python salesforce_health_cloud_pipeline.py

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

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

Inspect your pipeline and data:

uv run dlthub 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 /services/oauth2/token and /services/data/vXX.X/ from the Salesforce Health Cloud 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 salesforce_health_cloud_source(access_token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.healthcloud.salesforce.com", "auth": {"type": "bearer", "token": access_token}, }, "resources": [ {"name": "query", "endpoint": {"path": "services/data/v{version}/query", "data_selector": "records"}}, {"name": "get_updated", "endpoint": {"path": "services/data/v{version}/sobjects/{sObject}/updated", "data_selector": "ids"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="salesforce_health_cloud_pipeline", destination="duckdb", dataset_name="salesforce_health_cloud_data", ) load_info = pipeline.run(salesforce_health_cloud_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("salesforce_health_cloud_pipeline").dataset() sessions_df = data.query.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM salesforce_health_cloud_data.query LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("salesforce_health_cloud_pipeline").dataset() data.query.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 Salesforce Health Cloud data to?

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

DestinationExample 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 harness:

  • data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
  • dlthub-platform — Deploy, schedule, and monitor your pipeline in production.
uv run dlthub ai toolkit install data-exploration uv run dlthub ai toolkit install dlthub-platform

Was this page helpful?

Community Hub

Need more dlt context for Salesforce Health Cloud?

Request dlt skills, commands, AGENT.md files, and AI-native context.