WorkflowMax2 Python API Docs | dltHub

WorkflowMax2 REST API is an API for accessing the WorkflowMax job management tool, allowing interaction with entities such as jobs, clients, quotes, invoices, and timesheets. The REST API base URL is https://api.workflowmax.com/v2 and All requests require a Bearer token for authentication and an Account ID in the 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 WorkflowMax2 data in under 10 minutes.

---

What data can I load from WorkflowMax2?

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

---

How do I authenticate with the WorkflowMax2 API?

Authentication requires an OAuth2 Bearer token, which needs to be included in the 'Authorization' header, along with an 'Account-ID' header containing the organization ID.

1. Get your credentials

To obtain API credentials, you typically need to register your application to get a Client ID and Client Secret. Then, you can initiate the OAuth2 flow to exchange an authorization code for an access token and a refresh token. The access token is used for API calls, and the refresh token can be used to obtain new access tokens when the current one expires.

2. Add them to .dlt/secrets.toml

Copy
[sources.workflow_max_source]
client_id = "your_client_id_here"
client_secret = "your_client_secret_here"
access_token = "your_access_token_here"
refresh_token = "your_refresh_token_here"
account_id = "your_account_id_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 venv && source .venv/bin/activate
uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

Copy
dlt 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
dlt 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 WorkflowMax2 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 workflow_max_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline workflow_max_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 clients and jobs from the WorkflowMax2 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 workflow_max_source(access_token, account_id=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.workflowmax.com/v2",
            "auth": {
                "type": "oauth2",
                "access_token": access_token, account_id,
            },
        },
        "resources": [
            {"name": "clients", "endpoint": {"path": "clients", "data_selector": "Clients"}},
            {"name": "jobs", "endpoint": {"path": "jobs", "data_selector": "Jobs"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM workflow_max_data.clients LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("workflow_max_pipeline").dataset()
data.clients.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 WorkflowMax2 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.

---

Troubleshooting

Access Token Expiration

Access tokens for the WorkflowMax API expire after 30 minutes. If you encounter authentication errors after a short period, ensure you are refreshing your access token using the provided refresh token. Refresh tokens are valid for 60 days.

Missing Account ID

All API calls require an account_id header containing your organization ID. If you receive unauthorized errors, verify that this header is correctly included in your requests.

Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.

---

Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:

• data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
• dlthub-runtime — Deploy, schedule, and monitor your pipeline in production.

Copy
dlt ai toolkit data-exploration install
dlt ai toolkit dlthub-runtime 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