Easy projects Python API Docs | dltHub

Easy Project is a web‑based project management platform exposing a REST API for managing projects, tasks, users, time entries, CRM cases and related entities. The REST API base URL is https://{your_easyproject_instance} and All requests require instance‑specific API credentials (API token or key) supplied via a request 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 Easy projects data in under 10 minutes.

---

What data can I load from Easy projects?

Here are some of the endpoints you can load from Easy projects:

---

How do I authenticate with the Easy projects API?

Easy Project uses instance‑managed API authentication. Provide the API token in the header defined by your instance (commonly X‑Api‑Key or Authorization).

1. Get your credentials

1. Log in to Easy Project as an administrator.
2. Navigate to Administration » Settings » Authentication.
3. Locate the API token/key section and click "Generate" (or enable API access for a user).
4. Copy the generated token.
5. Store the token securely (e.g., in secrets.toml) for use in the dlt pipeline. If you lack admin rights, request a token from your Easy Project administrator.

2. Add them to .dlt/secrets.toml

Copy
[sources.easy_projects_source]
api_key = "your_api_key_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 Easy projects 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 easy_projects_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline easy_projects_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 tasks and projects from the Easy projects 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 easy_projects_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://{your_easyproject_instance}",
            "auth": {
                "type": "api_key",
                "api_key": api_key,
            },
        },
        "resources": [
            {"name": "tasks", "endpoint": {"path": "api/tasks", "data_selector": "tasks"}},
            {"name": "projects", "endpoint": {"path": "api/projects", "data_selector": "projects"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM easy_projects_data.tasks LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("easy_projects_pipeline").dataset()
data.tasks.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 Easy projects 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

Authentication failures

If you receive 401 or 403 responses, verify that a valid API token is being sent in the correct header as defined in your instance's authentication settings. Ensure the token has not expired and that the associated user has permission to access the requested resource.

Rate limits

Easy Project defaults to 150 GET requests per minute, 50 write requests per minute, and 10 export requests per 5 minutes (version 15.3.0). Exceeding these limits returns a 429 response; implement exponential backoff and reduce request frequency.

Pagination

Most list endpoints are paginated. Use query parameters such as page and per_page (or limit/offset depending on the instance) and follow the response metadata (total_pages, total_count) to iterate through all records.

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