Organizr Python API Docs | dltHub

Organizr's API Socks allows direct access to service APIs without reverse proxy. Enable it to access services over WAN securely. This feature requires no additional setup beyond enabling it in Organizr settings. The REST API base URL is https://{ORGANIZR_DOMAIN}/api/v2 and All Organizr API requests require an Organizr API key sent in the Token header (or use Organizr JWT cookie for server‑auth flows)..

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

---

What data can I load from Organizr?

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

---

How do I authenticate with the Organizr API?

Organizr exposes an API key accepted via the HTTP header named Token for API calls. For server‑level authorization you can also rely on Organizr JWT cookies (organizr_token_) validated with your organizrHash secret.

1. Get your credentials

1. Log in to your Organizr instance as an admin. 2) Create or view an API key in the Organizr dashboard (API keys are shown as Token). 3) Use that key in requests by setting the HTTP header: Token: <your_api_key>. For server‑auth JWT flow: retrieve your instance's organizrHash and uuid from /config/www/Dashboard/api/config/config.php and use the cookie named organizr_token_.

2. Add them to .dlt/secrets.toml

Copy
[sources.organizr_source]
token = "your_organizr_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 Organizr 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 organizr_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline organizr_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 socks_service and multiple_socks_service from the Organizr 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 organizr_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://{ORGANIZR_DOMAIN}/api/v2",
            "auth": {
                "type": "api_key",
                "token": api_key,
            },
        },
        "resources": [
            {"name": "socks_service", "endpoint": {"path": "socks/{SERVICE}/"}},
            {"name": "multiple_socks_service", "endpoint": {"path": "multiple/socks/{SERVICE}/{#}"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM organizr_data.socks_service LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("organizr_pipeline").dataset()
data.socks_service.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 Organizr 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