Vtiger Python API Docs | dltHub

The Vtiger REST API allows seamless interaction with Vtiger CRM, enabling data access and integration with external systems. The API is part of all Vtiger releases, including the open-source version. To enable REST APIs in Vtiger 7.5, refer to the official documentation. The REST API base URL is https://<your-vtiger-instance>/restapi/v1/vtiger and All requests require HTTP Basic authentication using the CRM username and access key..

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

---

What data can I load from Vtiger?

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

---

How do I authenticate with the Vtiger API?

Include an "Authorization: Basic <base64(username:access_key)>" header with each request.

1. Get your credentials

1. Log in to your Vtiger CRM instance with an administrator account.
2. Navigate to Settings → CRM Settings → API.
3. Locate the Access Key field for the desired user (or create a new API user).
4. Copy the Username and the generated Access Key; these are the credentials required for HTTP Basic authentication.
5. Store the values securely for use in dlt configuration.

2. Add them to .dlt/secrets.toml

Copy
[sources.vtiger_source]
username = "your_username"
password = "your_access_key"

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 Vtiger 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 vtiger_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline vtiger_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 me and listtypes from the Vtiger 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 vtiger_source(username=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://<your-vtiger-instance>/restapi/v1/vtiger",
            "auth": {
                "type": "http_basic",
                "password": username,
            },
        },
        "resources": [
            {"name": "listtypes", "endpoint": {"path": "listtypes?fieldTypeList=null", "data_selector": "result"}},
            {"name": "retrieve", "endpoint": {"path": "retrieve?id=record_Id", "data_selector": "result"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM vtiger_data.listtypes LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("vtiger_pipeline").dataset()
data.listtypes.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 Vtiger 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 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