Redbooth Python API Docs | dltHub

Build a Redbooth-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.

Last updated:

Redbooth is a collaborative project management and task tracking platform offering a REST API for programmatic access. The REST API base URL is https://redbooth.com/api/3 and All requests require an OAuth2 Bearer token for authentication..

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


What data can I load from Redbooth?

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

ResourceEndpointMethodData selectorDescription
activities/activitiesGETactivitiesList of activity objects the user can access.
me/meGETUser profile information for the authenticated user.
projects/projectsGETprojectsList of projects the user can access.
tasks/tasksGETtasksList of task objects.
task_lists/task_listsGETtask_listsList of task list objects.

How do I authenticate with the Redbooth API?

Redbooth uses OAuth2 Bearer tokens passed in the Authorization header (e.g., Authorization: Bearer <access_token>) or as an access_token query parameter.

1. Get your credentials

  1. Open https://redbooth.com/oauth2/applications/new and create a new application.
  2. Note the generated API Key (client_id) and App Secret (client_secret).
  3. Direct the user through the OAuth authorization flow to receive an authorization code.
  4. Exchange the code for an access token with a POST to https://redbooth.com/oauth2/token (client_id, client_secret, code, grant_type=authorization_code, redirect_uri).
  5. Store the received access_token (and refresh_token if needed) for use in API calls.

2. Add them to .dlt/secrets.toml

[sources.redbooth_source] access_token = "your_access_token_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:

uv venv && source .venv/bin/activate uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

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:

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 Redbooth 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:

python redbooth_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline redbooth_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 activities and projects from the Redbooth API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def redbooth_source(access_token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://redbooth.com/api/3", "auth": { "type": "bearer", "token": access_token, }, }, "resources": [ {"name": "activities", "endpoint": {"path": "activities", "data_selector": "activities"}}, {"name": "projects", "endpoint": {"path": "projects", "data_selector": "projects"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="redbooth_pipeline", destination="duckdb", dataset_name="redbooth_data", ) load_info = pipeline.run(redbooth_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):

import dlt data = dlt.pipeline("redbooth_pipeline").dataset() sessions_df = data.activities.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM redbooth_data.activities LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("redbooth_pipeline").dataset() data.activities.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 Redbooth data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

DestinationExample value
DuckDB (local, default)"duckdb"
PostgreSQL"postgres"
BigQuery"bigquery"
Snowflake"snowflake"
Redshift"redshift"
Databricks"databricks"
Filesystem (S3, GCS, Azure)"filesystem"

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 a 401 Unauthorized response, verify that the access token is valid, not expired, and included either in the Authorization: Bearer <token> header or as the access_token query parameter.

Rate limiting

Redbooth caps list endpoints to 1,000 records per request. Exceeding this limit without pagination will truncate results. Use the page and per_page query parameters to retrieve additional pages.

Pagination quirks

The page parameter starts at 1. Supplying a page value beyond the available range returns an empty array. Always check the length of the returned list before requesting the next page.

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

Was this page helpful?

Community Hub

Need more dlt context for Redbooth?

Request dlt skills, commands, AGENT.md files, and AI-native context.