Workday Python API Docs | dltHub

Workday REST API provides JSON-based access to Workday data across domains like HCM, Financial Management, and Recruiting. The REST API base URL is https://{tenant}.workday.com/ccx/api and all requests require a Bearer token obtained via OAuth 2.0 flow.

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

---

What data can I load from Workday?

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

---

How do I authenticate with the Workday API?

Workday REST APIs use OAuth 2.0 authentication. Requests must include an Authorization header with the value 'Bearer <access_token>'.

1. Get your credentials

1. Log in to your Workday tenant with administrative privileges. 2. Search for the task 'Register API Client for Integrations' and create a new client. 3. Select 'Client Credentials' as the Grant Type for server-to-server integrations. 4. Assign the appropriate functional scopes (e.g., 'Staffing', 'Human Resources') required for your API operations. 5. Save the configuration to generate your Client ID and Client Secret. Ensure you copy the Client Secret immediately, as it will not be displayed again. 6. Create an Integration System User (ISU) if one does not already exist, and use the 'Create Client Credentials Mapping' task to bind your new API Client ID to that ISU. This establishes the security context for your API calls.

2. Add them to .dlt/secrets.toml

Copy
[sources.workday_source]
api_key = "REPLACE_ME"

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 Workday 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 workday_pipeline.py

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

Copy
Pipeline workday_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset workday_data
The duckdb destination used duckdb:/workday.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 /workers and /supervisoryOrganizations from the Workday 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 workday_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://{tenant}.workday.com/ccx/api",
            "auth": {"type": "bearer", "token": api_key},
        },
        "resources": [
            {"name": "workers", "endpoint": {"path": "workers", "data_selector": "data"}},
            {"name": "jobs", "endpoint": {"path": "jobs", "data_selector": "data"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM workday_data.workers LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("workday_pipeline").dataset()
data.workers.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 Workday 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