Zoho-sheet Python API Docs | dltHub

Zoho Sheet is an online spreadsheet service that exposes Data and Content REST APIs allowing programmatic access to list workbooks, read and update worksheets, ranges, rows (tabular data), upload workbooks and operate on cells/worksheets. The REST API base URL is https://sheet.zoho.com/api/v2 and All requests require an OAuth2 access token in the Authorization header ("Zoho-oauthtoken ")..

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

---

What data can I load from Zoho-sheet?

Here are some of the endpoints you can load from Zoho-sheet:

---

How do I authenticate with the Zoho-sheet API?

Zoho Sheet uses OAuth2.0. Obtain client_id/client_secret in Zoho Accounts Developer Console, perform the authorization_code (or device/non-browser flow) to get an access_token and optional refresh_token. Send the access token in request header as: Authorization: Zoho-oauthtoken <access_token>. API responses include api_domain which may be used as the API host.

1. Get your credentials

1. Go to Zoho Accounts Developer Console (https://accounts.zoho.com/developerconsole).
2. Create a new client (choose Server‑based, Client‑based or Non‑browser as appropriate) to obtain client_id and client_secret.
3. Use https://accounts.zoho.com/oauth/v2/auth with response_type=code, scope=ZohoSheet.dataAPI.READ (and UPDATE if writes needed), redirect_uri and access_type=offline & prompt=consent to get an authorization code.
4. Exchange the code for tokens at https://accounts.zoho.com/oauth/v2/token with grant_type=authorization_code, client_id and client_secret.
5. Use the returned access_token in Authorization: Zoho‑oauthtoken <access_token>. Refresh tokens at https://accounts.zoho.com/oauth/v2/token with grant_type=refresh_token.

2. Add them to .dlt/secrets.toml

Copy
[sources.zoho_sheet_source]
access_token = "your_oauth_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:

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 Zoho-sheet 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 zoho_sheet_pipeline.py

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

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

Inspect your pipeline and data:

Copy
dlt pipeline zoho_sheet_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 worksheets and tabular_rows from the Zoho-sheet 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 zoho_sheet_source(access_token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://sheet.zoho.com/api/v2",
            "auth": {
                "type": "bearer",
                "access_token": access_token,
            },
        },
        "resources": [
            {"name": "worksheets", "endpoint": {"path": "api/v2/<resource_id>/worksheets", "data_selector": "worksheets"}},
            {"name": "tabular_rows", "endpoint": {"path": "api/v2/<resource_id>/rows", "data_selector": "rows"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM zoho_sheet_data.worksheets LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("zoho_sheet_pipeline").dataset()
data.worksheets.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 Zoho-sheet 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 error code 2401/2403/2404 expect invalid/expired token, wrong scope or lack of access to the workbook. Verify token is sent as header: Authorization: Zoho-oauthtoken <access_token>. Use the refresh_token flow to renew tokens.

Rate limits and throttle

Zoho Sheet enforces per‑minute API call limits per document; exceeding limits returns throttle error (2950) and affected APIs may be blocked for ~5 minutes. Implement retries with exponential backoff and respect per‑minute quotas.

Pagination & large results

Tabular APIs and list endpoints may paginate. Use provided query parameters (start_row, start_column, limit) and iterate until no more rows are returned. Watch for "no defined column" (2884) or "too many matches" (2881) for find APIs.

Common API errors

• 2401 Authentication failure
• 2402 Operation not allowed
• 2403 Invalid scope
• 2404 Access denied to workbook
• 2831 Missing parameter
• 2832 Wrong value
• 2833 Wrong type
• 2862 No such workbook
• 2863 No such worksheet
• 2870 Row limit exceeded
• 2871 Column limit exceeded
• 2950 Throttle limit exceeded

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