Load HRworks data to DuckDB
Build a HRworks to DuckDB pipeline with your coding agent. One prompt scaffolds it with the dltHub AI harness, plus the HRworks API base URL, auth, endpoints, and incremental loading.
HRworks is a German HR and payroll platform providing a REST API for accessing employee, absence, and payroll data. Everything needed to build a working HRworks → 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 HRworks to DuckDB pipeline
Paste this prompt into Claude, Codex, or Cursor. The agent does the rest.
PromptRunuvx dlthub-init@latestto build a pipeline from HRworks 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 HRworks 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.
HRworks API at a glance
| Base URL | https://api.hrworks.de/v2 |
| Example endpoint | GET v2/organization-units |
| Records found at | data |
| Authentication | all requests require a Bearer token in the Authorization header — sent in the Authorization header, prefixed Bearer |
| Pagination | Page-number. The HRworks API uses page-based pagination. The 'page' query parameter is used to navigate results. Paging information is provided via the Link header. The API documentation does not specify a way to change the page size via a query parameter; it appears to be fixed per endpoint (e.g., 50 or 150). |
| API reference | https://developers.hrworks.de/docs/hrworks-api-v2/p5jm7ezw8i1pw-welcome-to-the-hr-works-public-api-v2 |
These values come from the HRworks API reference — the authoritative source if anything here looks out of date.
How do I authenticate with the HRworks API?
Authentication requires a POST request to the /v2/authentication endpoint using accessKey and secretAccessKey credentials to receive a short-lived JWT, which must then be sent in the 'Authorization' header using the 'Bearer' scheme for all subsequent requests.
1. Get your credentials
- Log into your HRworks instance as an administrator. 2. In the sidebar, navigate to Basics and select Integrations. 3. Click on the HR WORKS-API tile. 4. Click the New key pair button to generate a new set of credentials. 5. Download the provided .txt file containing your accessKey and secretAccessKey. 6. Select the newly generated key pair, configure the required permissions (scopes) at the bottom of the page, and save your changes. Use these credentials to authenticate against the /v2/authentication endpoint to obtain a bearer token for API access.
2. Add them to .dlt/secrets.toml
[sources.hrworks_source] token = "your_jwt_token_here"
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 HRworks data can I load into DuckDB?
These are the HRworks endpoints dlt can load into DuckDB:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| health_check | /v2/health-check | GET | Simple health check; returns 200 when API is available. | |
| organization_units | /v2/organization-units | GET | data | Lists organization units for the company. |
| permanent_establishments | /v2/permanent-establishments | GET | data | Lists all permanent establishments. |
| absences | /v2/absences | GET | data | Lists absences for specified persons and date interval. |
| persons | /v2/persons | GET | data | Lists persons (employees). |
| absence_types | /v2/absences/absence-types | GET | data | Lists absence type definitions. |
How do I load only new HRworks records?
The HRworks 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": "organization_units", "endpoint": { "path": "v2/organization-units", # 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 HRworks pipeline look like?
A standard dlt REST API pipeline — the same code you would write by hand, loading /v2/authentication and /v2/persons (or /v2/absences) from the HRworks API into DuckDB:
import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def hrworks_source(token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.hrworks.de/v2", "auth": {"type": "bearer", "token": token}, }, "resources": [ {"name": "organization_units", "endpoint": {"path": "v2/organization-units", "data_selector": "data"}}, {"name": "persons", "endpoint": {"path": "v2/persons", "data_selector": "data"}} ], } yield from rest_api_resources(config) def load_hrworks_to_duckdb() -> None: pipeline = dlt.pipeline( pipeline_name="hrworks_pipeline", destination="duckdb", dataset_name="hrworks_data", ) load_info = pipeline.run(hrworks_source()) print(load_info) if __name__ == "__main__": load_hrworks_to_duckdb()
Run it with python hrworks_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 HRworks 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("hrworks_pipeline").dataset() df = data.persons.df() print(df.head())
SQL:
SELECT * FROM hrworks_data.persons LIMIT 10;
See querying your data with dataset and exploring it in marimo notebooks.
How do I deploy the HRworks 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 HRworks 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 HRworks 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 HRworks to DuckDB?
Request dlt skills, commands, AGENT.md files, and AI-native context.