Zoho recruit Python API Docs | dltHub

Zoho Recruit API is a recruitment management system that allows programmatic access to manage various recruitment-related modules such as candidates, job openings, and users. The REST API base URL is https://recruit.zoho.com/recruit/v2/ and All requests to the Zoho Recruit API require an OAuth2.0 access 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 Zoho recruit data in under 10 minutes.

---

What data can I load from Zoho recruit?

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

---

How do I authenticate with the Zoho recruit API?

The Zoho Recruit API uses OAuth2.0 for authentication. Access tokens, valid for one hour, must be included in the 'Authorization' header as 'Zoho-oauthtoken {access_token}'.

1. Get your credentials

To obtain API credentials for Zoho Recruit, you need to register your application with Zoho. This process typically involves creating a new client in the Zoho API Console, which will provide you with a client ID, client secret, and allow you to configure redirect URIs. These credentials are then used to initiate the OAuth2.0 flow to get access and refresh tokens.

2. Add them to .dlt/secrets.toml

Copy
[sources.zoho_recruit_source]
client_id = "your_client_id"
client_secret = "your_client_secret"
access_token = "your_access_token"
refresh_token = "your_refresh_token"

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 recruit 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_recruit_pipeline.py

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

Copy
Pipeline zoho_recruit_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset zoho_recruit_data
The duckdb destination used duckdb:/zoho_recruit.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_recruit_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 records and users from the Zoho recruit 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_recruit_source(access_token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://recruit.zoho.com/recruit/v2/",
            "auth": {
                "type": "oauth2.0",
                "access_token": access_token,
            },
        },
        "resources": [
            {"name": "records", "endpoint": {"path": "{module_api_name}", "data_selector": "data"}},
            {"name": "users", "endpoint": {"path": "users", "data_selector": "users"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="zoho_recruit_pipeline",
        destination="duckdb",
        dataset_name="zoho_recruit_data",
    )
    load_info = pipeline.run(zoho_recruit_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_recruit_pipeline").dataset()
sessions_df = data.records.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM zoho_recruit_data.records LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("zoho_recruit_pipeline").dataset()
data.records.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 recruit 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

Rate Limits

Zoho Recruit API has a default per_page limit of 200 records. If more records are requested, the API will return a maximum of 200 records per page. Pagination must be handled by incrementing the page parameter.

Common Errors

• 400 INVALID_MODULE: Occurs when an invalid module API name is provided in the request URL.
• 403 NOT_SUPPORTED: Occurs when the requested operation is not supported for the given module or context.

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