Installation & Usage
[01]
Install Package
Using uv or pip
BASH
uv pip install airbyte-agent-zoho-crm
[02]
Import
Initialize and use
PYTHON
from airbyte_agent_zoho_crm import ZohoCrmConnector
from airbyte_agent_zoho_crm.models import ZohoCrmAuthConfig
connector = ZohoCrmConnector(
auth_config=ZohoCrmAuthConfig(
client_id="<OAuth 2.0 Client ID from Zoho Developer Console>",
client_secret="<OAuth 2.0 Client Secret from Zoho Developer Console>",
refresh_token="<OAuth 2.0 Refresh Token (does not expire)>"
)
)[03]
Tool
Add tools to your agent
python
@agent.tool_plain # assumes you're using Pydantic AI
@ZohoCrmConnector.tool_utils
async def zoho_crm_execute(entity: str, action: str, params: dict | None = None):
return await connector.execute(entity, action, params or {})Supported Entities & Actions
Lorem ipsum
Lorem ipsum
| Entity | Actions |\n|--------|---------|\n| Leads | [List](./REFERENCE.md#leads-list), [Get](./REFERENCE.md#leads-get), [Search](./REFERENCE.md#leads-search) |\n| Contacts | [List](./REFERENCE.md#contacts-list), [Get](./REFERENCE.md#contacts-get), [Search](./REFERENCE.md#contacts-search) |\n| Accounts | [List](./REFERENCE.md#accounts-list), [Get](./REFERENCE.md#accounts-get), [Search](./REFERENCE.md#accounts-search) |\n| Deals | [List](./REFERENCE.md#deals-list), [Get](./REFERENCE.md#deals-get), [Search](./REFERENCE.md#deals-search) |\n| Campaigns | [List](./REFERENCE.md#campaigns-list), [Get](./REFERENCE.md#campaigns-get), [Search](./REFERENCE.md#campaigns-search) |\n| Tasks | [List](./REFERENCE.md#tasks-list), [Get](./REFERENCE.md#tasks-get), [Search](./REFERENCE.md#tasks-search) |\n| Events | [List](./REFERENCE.md#events-list), [Get](./REFERENCE.md#events-get), [Search](./REFERENCE.md#events-search) |\n| Calls | [List](./REFERENCE.md#calls-list), [Get](./REFERENCE.md#calls-get), [Search](./REFERENCE.md#calls-search) |\n| Products | [List](./REFERENCE.md#products-list), [Get](./REFERENCE.md#products-get), [Search](./REFERENCE.md#products-search) |\n| Quotes | [List](./REFERENCE.md#quotes-list), [Get](./REFERENCE.md#quotes-get), [Search](./REFERENCE.md#quotes-search) |\n| Invoices | [List](./REFERENCE.md#invoices-list), [Get](./REFERENCE.md#invoices-get), [Search](./REFERENCE.md#invoices-search) |
Example Prompts
Lorem ipsum
List all leads - Show me details for a specific lead - List all contacts - List all accounts - List all open deals - Show me details for a specific deal - List all campaigns - List all tasks - List all events - List recent calls - List all products - List all quotes - List all invoices - Show me leads created in the last 30 days - Which deals have the highest amount? - List all contacts at a specific company - What is the total revenue across all deals by stage? - Show me overdue tasks - Which campaigns generated the most leads? - Summarize the deal pipeline by stage - Show me accounts with the highest annual revenue - List all events scheduled for this week - What are the top-performing products by unit price? - Show me all invoices that are past due - Break down leads by source and industry
Why Airbyte for AI Agents?
Built for production AI workloads with enterprise-grade reliability
Secure Authentication
Built-in OAuth 2.0 handling with automatic token refresh. No hard-coded credentials.
Agent-Native Design
Heading
Structured, LLM-friendly schemas optimized for AI agent consumption with natural language query support.
Production Ready
Battle-tested connectors with comprehensive error handling, logging, and retry logic.
Open Source
Fully open source under the MIT license. Contribute, customize, and extend freely.
Works with your favorite frameworks
LangChain
CrewAI
LlamaIndex
AutoGen
OpenAI Agents SDK
Claude Agents SDK
Frequently Asked Questions
Didn't find your answer? Please don't hesitate to reach out.
The Zoho CRM connector supports OAuth 2.0 authentication. You provide a client ID, client secret, and a refresh token (which does not expire) obtained from the Zoho Developer Console. It also supports regional data center configurations for US, EU, AU, IN, CN, and JP regions. In hosted mode, credentials are stored securely in Airbyte Cloud and you authenticate via Airbyte client credentials instead.
Can I use this connector with any AI agent framework?
The connector is compatible with any Python-based AI agent framework including LangChain, LlamaIndex, CrewAI, Pydantic AI, and custom implementations.
Does this connector support write operations?
No, the Zoho CRM connector currently supports read-only operations (list, get, and search) for all entities. Write operations such as creating leads, updating contacts, deleting records, sending emails, converting leads, or merging contacts are not supported at this time.
How is this different from the Airbyte data connector?
Agent connectors are specifically designed for AI agents and LLM applications. They provide natural language interfaces, optimized response formats, and seamless integration with agent frameworks, unlike traditional ETL-focused connectors.
Get started in minutes with our open-source connector.