Greenhouse Python API Docs | dltHub

Greenhouse is a recruiting platform offering the Harvest REST API to programmatically access recruiting data such as candidates, jobs, and applications. The REST API base URL is https://harvest.greenhouse.io/v1 and all requests require HTTP Basic authentication with the API token as the username and a blank password.

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 Greenhouse data in under 10 minutes.

---

What data can I load from Greenhouse?

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

---

How do I authenticate with the Greenhouse API?

The Harvest API utilizes HTTP Basic Authentication over HTTPS. The username is the API token, and the password must be blank (empty).

1. Get your credentials

To obtain API credentials in Greenhouse Recruiting: 1. Sign in to your Greenhouse account as a Site Admin. 2. Click the Configure icon (gear icon) in the navigation bar. 3. Select Dev Center from the left-hand menu. 4. Click API Credential Management. 5. Click Create new API credentials. 6. Choose the appropriate API type (Harvest for v1/v2, or Harvest v3 for OAuth). 7. Select a Partner (choose 'custom' if building your own integration), provide a Description, and click Manage permissions or View and store credentials. 8. Securely store the generated API Key or Client ID/Secret, as they may only be displayed once. 9. Assign the required endpoint permissions and click Save.

2. Add them to .dlt/secrets.toml

Copy
[sources.greenhouse_source]
api_token = "your_harvest_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 harness:

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

Copy
dlthub 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 Greenhouse 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 greenhouse_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline greenhouse_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 v1/candidates and v1/jobs from the Greenhouse 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 greenhouse_source(api_token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://harvest.greenhouse.io/v1",
            "auth": {"type": "http_basic", "username": "REPLACE_ME", "password": api_token},
        },
        "resources": [
            {"name": "candidates", "endpoint": {"path": "v3/candidates", "data_selector": "candidates"}},
            {"name": "jobs", "endpoint": {"path": "v3/jobs", "data_selector": "jobs"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM greenhouse_data.candidates LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("greenhouse_pipeline").dataset()
data.candidates.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 Greenhouse 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.

---

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.

Copy
dlthub ai toolkit data-exploration install
dlthub ai toolkit dlthub-platform 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