Breezy HR Python API Docs | dltHub

Breezy HR is a recruiting and applicant tracking platform that provides a REST API for managing candidates, positions, pipelines, and recruitment activity data. The REST API base URL is https://api.breezy.hr/v3 and all requests require an Authorization header with an API access token.

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

---

What data can I load from Breezy HR?

Here are some of the endpoints you can load from Breezy HR:

---

How do I authenticate with the Breezy HR API?

All requests (except /v3/signin and /v3/health) require an 'Authorization' header containing the Personal Access Token (PAT) or session access token. Personal Access Tokens are prepended with 'breezypat'.

1. Get your credentials

To obtain an API key (Personal Access Token) for Breezy HR, follow these steps: 1. Sign in to your Breezy HR account. 2. Click your profile/user icon located in the bottom-left corner of the sidebar. 3. Navigate to 'My Settings'. 4. Click on the 'API Keys' tab near the top of the screen. 5. Click the '+ Create API Key' button. 6. Enter a descriptive name for the key and select an expiration timeframe. 7. Click 'Create Key'. The API key will be displayed; copy it immediately as it is only shown once and cannot be retrieved later. PATs carry the prefix 'breezypat'.

2. Add them to .dlt/secrets.toml

Copy
[sources.breezy_hr_source]
api_key = "breezypat_your_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:

Copy
uv init
uv add "dlt[hub]"

1. Install the dlt AI harness:

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

Copy
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 Breezy HR 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
uv run python breezy_hr_pipeline.py

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

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

Inspect your pipeline and data:

Copy
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 /v3/companies and /v3/company/{company_id}/webhook_endpoints from the Breezy HR 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 breezy_hr_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.breezy.hr/v3",
            "auth": {"type": "api_key", "api_key": api_key, "name": "Authorization"},
        },
        "resources": [
            {"name": "company_positions", "endpoint": {"path": "v3/company/{company_id}/positions"}},
            {"name": "position_candidates", "endpoint": {"path": "v3/company/{company_id}/position/{position_id}/candidates"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM breezy_hr_data.company_positions LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("breezy_hr_pipeline").dataset()
data.company_positions.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 Breezy HR 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
uv run dlthub ai toolkit install data-exploration
uv run dlthub ai toolkit install dlthub-platform

• 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