UKG Ready Python API Docs | dltHub

UKG Ready is a unified Human Capital Management suite providing RESTful access to HR, payroll, and workforce data. The REST API base URL is https://{hostname}/api and All requests require an OAuth 2.0 Bearer token in the Authorization header..

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

---

What data can I load from UKG Ready?

Here are some of the endpoints you can load from UKG Ready:

---

How do I authenticate with the UKG Ready API?

Authentication uses OAuth 2.0; clients exchange credentials for an access token and must provide this token in the Authorization header of subsequent requests using the 'Bearer' scheme.

1. Get your credentials

To obtain API credentials, you must have administrator access to your UKG Ready instance. Navigate to 'Settings' > 'Global Setup' > 'Company Setup'. In the 'Login Config' tab, find the 'OAuth Applications' section to create a 'Machine to Machine' application, which will generate your 'Client ID' and 'Client Secret'. Note that the Client Secret is only displayed once upon creation and must be stored securely. For integrations requiring an API Key, scroll to the 'API Keys' section within the same 'Login Config' tab and click 'Generate'. If an API Key already exists, reuse the existing one instead of generating a new one to avoid disrupting existing integrations. You will also need your 'Hostname' (from the instance login URL) and 'Company ID' (often found by adding the 'Company ID' column in your Employee info report).

2. Add them to .dlt/secrets.toml

Copy
[sources.ukg_ready_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 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 UKG Ready 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 ukg_ready_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline ukg_ready_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 /authentication/access_token and /rest/v1/login from the UKG Ready 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 ukg_ready_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://{hostname}/api",
            "auth": {"type": "bearer", "token": api_key},
        },
        "resources": [
            {"name": "groups", "endpoint": {"path": "group/v1/groups"}},
            {"name": "groups", "endpoint": {"path": "group/v1/groups", "data_selector": "items"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM ukg_ready_data.groups LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("ukg_ready_pipeline").dataset()
data.groups.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 UKG Ready 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