Saleshandy Python API Docs | dltHub

Saleshandy is a sales engagement platform providing email outreach, prospect management, sequences, analytics and related automation via a REST API. The REST API base URL is https://open-api.saleshandy.com/v1 and all requests require an API key passed in the x-api-key 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 pip install "dlt[workspace]" and start loading Saleshandy data in under 10 minutes.

---

What data can I load from Saleshandy?

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

---

How do I authenticate with the Saleshandy API?

Saleshandy uses API keys. Include the API key in the x-api-key HTTP header for all requests (e.g. x-api-key: YOUR_KEY).

1. Get your credentials

1. Log in to your Saleshandy account. 2) Open Settings → API Key (or API Keys). 3) Create a new API key, give it a label and copy the generated key. 4) Store the key securely; it will not be shown again.

2. Add them to .dlt/secrets.toml

Copy
[sources.saleshandy_source]
api_key = "your_saleshandy_api_key_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 Saleshandy 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 saleshandy_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline saleshandy_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 prospects and sequences from the Saleshandy 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 saleshandy_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://open-api.saleshandy.com/v1",
            "auth": {
                "type": "api_key",
                "api_key": api_key,
            },
        },
        "resources": [
            {"name": "prospects", "endpoint": {"path": "v1/prospects", "data_selector": "data"}},
            {"name": "sequences", "endpoint": {"path": "v1/sequences", "data_selector": "data"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="saleshandy_pipeline",
        destination="duckdb",
        dataset_name="saleshandy_data",
    )
    load_info = pipeline.run(saleshandy_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("saleshandy_pipeline").dataset()
sessions_df = data.prospects.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM saleshandy_data.prospects LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("saleshandy_pipeline").dataset()
data.prospects.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 Saleshandy 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

If you receive 401/403 responses verify the x-api-key header contains a valid API key and that it has not been revoked. Regenerate the key in Settings → API Keys if needed.

Rate limits and enrich endpoints

Enrichment endpoints expose a separate credit/rate system (enrich/credits and enrich/rate-limits). Check /v1/enrich/rate-limits or enrich/credits to monitor usage and avoid 429 responses.

Pagination

Many GET list endpoints are paginated. Inspect response meta fields (meta or pagination) and use query parameters (page, per_page, limit, offset) where supported to iterate pages until exhausted.

Import/status polling

When importing prospects or enrichment jobs the API returns a requestId — use the matching /import-status or /enrich/status endpoints to poll for completion rather than expecting immediate results.

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