Load Bamboohr data to DuckDB
Build a Bamboohr to DuckDB pipeline with your coding agent. One prompt scaffolds it with the dltHub AI harness, plus the Bamboohr API base URL, auth, endpoints, and incremental loading.
BambooHR is a cloud-based HR software platform that provides a REST API for accessing employee data, time tracking, and recruitment information. Everything needed to build a working Bamboohr → DuckDB pipeline is on this page: the API's base URL, authentication, endpoints, pagination and incremental field — plus a prompt that hands the whole job to your coding agent.
Build your Bamboohr to DuckDB pipeline
Paste this prompt into Claude, Codex, or Cursor. The agent does the rest.
PromptRunuvx dlthub-init@latestto build a pipeline from Bamboohr to DuckDB and run it on dltHub
That scaffolds a dltHub workspace and installs the dltHub AI harness — the project rules, the secrets-management skill, and the dlt MCP server your agent needs to work safely. From there it reads the Bamboohr API, proposes the endpoints to load, then writes, runs and validates the pipeline while you review rather than type. Credentials are inspected through MCP tools, so your agent never reads secrets.toml itself. How the LLM-native workflow works →
Prefer to write it yourself? Every fact the agent uses is below.
Bamboohr API at a glance
| Base URL | https://{companyDomain}.bamboohr.com/api/v1 |
| Example endpoint | GET employees |
| Records found at | data |
| Authentication | supports OAuth 2.0 and API Key via HTTP Basic Auth — sent in the Authorization header, prefixed Bearer |
| Pagination | Cursor-based via page[after], page size via page[limit] or pageSize. BambooHR uses different pagination styles across its API. Newer endpoints like List Employees use cursor-based pagination (page[limit], page[after/before]). Older datasets/reports use page number pagination (page, pageSize). |
| API reference | https://documentation.bamboohr.com/docs/getting-started |
These values come from the Bamboohr API reference — the authoritative source if anything here looks out of date.
How do I authenticate with the Bamboohr API?
BambooHR supports OAuth 2.0 (recommended) and API Key authentication. For API Keys, use HTTP Basic Authentication with the API key as the username and 'x' as the password. For OAuth, include the access token in the Authorization header as a Bearer token (e.g., 'Authorization: Bearer <access_token>').
1. Get your credentials
- Log in to your BambooHR account (https://[company].bamboohr.com) with administrator or Full Access permissions. 2. Click your profile photo in the upper right-hand corner of the page. 3. Select 'API Keys' from the user context menu. 4. Click 'Add New Key'. 5. Enter a descriptive name for the key (e.g., 'dlt integration'). 6. Click 'Generate Key'. 7. Copy the key immediately, as it will not be displayed again. If lost, you must generate a new one. Note: The API key inherits the permissions of the user who creates it.
2. Add them to .dlt/secrets.toml
[sources.bamboohr_source] api_key = "your_api_key_here" subdomain = "your_company_subdomain"
dlt reads this file automatically at runtime. With the harness, the setup-secrets skill prompts you for the values and never handles the raw credential in chat. For production, see setting up credentials with dlt.
What Bamboohr data can I load into DuckDB?
These are the Bamboohr endpoints dlt can load into DuckDB:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| employees_paginated | employees | GET | data | List employees with cursor-based pagination |
| employees_directory | employees/directory | GET | employees | Employee directory summary (legacy) |
| company_info | meta/company | GET | Get basic company information | |
| fields | meta/fields | GET | fields | Get list of available fields/metadata |
| time_off_requests | time_off/requests | GET | requests | Get time off requests |
| webhooks | webhooks | GET | webhooks | List configured webhooks |
How do I load only new Bamboohr records?
The Bamboohr API reference does not document a timestamp or sequence field for these endpoints, so there is nothing to advertise here as verified. Pick a field from the endpoints table above that increases with every write, then set it as the cursor_path.
{"name": "employees_paginated", "endpoint": { "path": "employees", # Replace with a field that increases on every write. "incremental": {"cursor_path": "REPLACE_ME", "initial_value": "2024-01-01T00:00:00Z"}, }}
On the first run dlt loads everything from initial_value; on every run after that it requests only what changed and appends with write_disposition="merge" if you set a primary key. See incremental loading.
What does the generated Bamboohr pipeline look like?
A standard dlt REST API pipeline — the same code you would write by hand, loading /api/v1/employees and /api/v1/company_reports from the Bamboohr API into DuckDB:
import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def bamboohr_source(api_key_or_access_token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://{companyDomain}.bamboohr.com/api/v1", "auth": {"type": "bearer", "token": api_key_or_access_token}, }, "resources": [ {"name": "employees_paginated", "endpoint": {"path": "employees", "data_selector": "data"}}, {"name": "employees_directory", "endpoint": {"path": "employees/directory", "data_selector": "employees"}} ], } yield from rest_api_resources(config) def load_bamboohr_to_duckdb() -> None: pipeline = dlt.pipeline( pipeline_name="bamboohr_pipeline", destination="duckdb", dataset_name="bamboohr_data", ) load_info = pipeline.run(bamboohr_source()) print(load_info) if __name__ == "__main__": load_bamboohr_to_duckdb()
Run it with python bamboohr_pipeline.py. The agent iterates on this until it loads cleanly — you review and approve, rather than write it from scratch.
How do I query Bamboohr data in DuckDB?
dlt creates one table per resource. Query the loaded data with Python or SQL — or ask your agent to, through the MCP server's execute_sql_query tool.
Python (pandas DataFrame):
import dlt data = dlt.pipeline("bamboohr_pipeline").dataset() df = data.employees_paginated.df() print(df.head())
SQL:
SELECT * FROM bamboohr_data.employees_paginated LIMIT 10;
See querying your data with dataset and exploring it in marimo notebooks.
How do I deploy the Bamboohr to DuckDB pipeline in production?
The pipeline runs locally, which is ideal for prototyping and one-off analysis. When you need it on a schedule, monitored on every load, and shared with your team, deploy the same dlt code on the dltHub platform — no infrastructure to maintain. The prompt above already ends with "run it on dltHub", so your agent can take it there directly.
- Deploy & schedule — run the pipeline as a managed job with automatic retries.
- Monitor — observable job queues, alerting, and load metrics for every run.
- Transform — promote raw Bamboohr loads into governed, documented models.
- Visualize & share — explore data in notebooks and publish live dashboards instead of static screenshots.
What other destinations can I load Bamboohr data to?
dlt loads into any of these — only the destination argument changes:
| Destination | Example value |
|---|---|
| PostgreSQL | "postgres" |
| BigQuery | "bigquery" |
| Snowflake | "snowflake" |
| Redshift | "redshift" |
| Databricks | "databricks" |
| Filesystem (S3, GCS, Azure) | "filesystem" |
Set dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. On the dltHub platform the same pipeline runs against a managed Iceberg lakehouse. See the full destinations list.
Next steps
Was this page helpful?
Community Hub
Need more dlt context for Bamboohr to DuckDB?
Request dlt skills, commands, AGENT.md files, and AI-native context.