Skip to main content

Airbyte Zoho-Crm Connector for AI platforms

Project description

Zoho-Crm

The Zoho-Crm agent connector is a Python package that equips AI agents to interact with Zoho-Crm through strongly typed, well-documented tools. It's ready to use directly in your Python app, in an agent framework, or exposed through an MCP.

Connector for the Zoho CRM API, providing access to CRM modules including leads, contacts, accounts, deals, campaigns, tasks, events, calls, products, quotes, and invoices. Supports OAuth 2.0 authentication with regional data center support (US, EU, AU, IN, CN, JP). Read-only operations (list and get) are supported for all entities.

Example questions

The Zoho-Crm connector is optimized to handle prompts like these.

  • 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

Unsupported questions

The Zoho-Crm connector isn't currently able to handle prompts like these.

  • Create a new lead in Zoho CRM
  • Update a contact's email address
  • Delete a deal record
  • Send an email to a lead
  • Convert a lead to a contact
  • Merge duplicate contacts

Installation

uv pip install airbyte-agent-zoho-crm

Usage

Connectors can run in open source or hosted mode.

Open source

In open source mode, you provide API credentials directly to the connector.

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)>",
        access_token="<OAuth 2.0 Access Token (auto-refreshed)>"
    )
)

@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 {})

Hosted

In hosted mode, API credentials are stored securely in Airbyte Cloud. You provide your Airbyte credentials instead. If your Airbyte client can access multiple organizations, also set organization_id.

This example assumes you've already authenticated your connector with Airbyte. See Authentication to learn more about authenticating. If you need a step-by-step guide, see the hosted execution tutorial.

from airbyte_agent_zoho_crm import ZohoCrmConnector, AirbyteAuthConfig

connector = ZohoCrmConnector(
    auth_config=AirbyteAuthConfig(
        customer_name="<your_customer_name>",
        organization_id="<your_organization_id>",  # Optional for multi-org clients
        airbyte_client_id="<your-client-id>",
        airbyte_client_secret="<your-client-secret>"
    )
)

@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 {})

Full documentation

Entities and actions

This connector supports the following entities and actions. For more details, see this connector's full reference documentation.

Entity Actions
Leads List, Get, Search
Contacts List, Get, Search
Accounts List, Get, Search
Deals List, Get, Search
Campaigns List, Get, Search
Tasks List, Get, Search
Events List, Get, Search
Calls List, Get, Search
Products List, Get, Search
Quotes List, Get, Search
Invoices List, Get, Search

Authentication

For all authentication options, see the connector's authentication documentation.

Zoho-Crm API docs

See the official Zoho-Crm API reference.

Version information

  • Package version: 0.1.0
  • Connector version: 1.0.1
  • Generated with Connector SDK commit SHA: cd5fc5a29e9673aaaf8e744def8471502c809f5d
  • Changelog: View changelog

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

airbyte_agent_zoho_crm-0.1.0.tar.gz (173.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

airbyte_agent_zoho_crm-0.1.0-py3-none-any.whl (197.0 kB view details)

Uploaded Python 3

File details

Details for the file airbyte_agent_zoho_crm-0.1.0.tar.gz.

File metadata

  • Download URL: airbyte_agent_zoho_crm-0.1.0.tar.gz
  • Upload date:
  • Size: 173.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for airbyte_agent_zoho_crm-0.1.0.tar.gz
Algorithm Hash digest
SHA256 7c9acd55fe7bdc62aaab7b69c8461834a894f27fa22c5211075c650cedbb0275
MD5 d6fadcebd33ec12e89f93efe12c6849f
BLAKE2b-256 224fd195c7841d6aa3fefbaa9713773b35c7b56e4204abf1f40bb99db231a2d3

See more details on using hashes here.

File details

Details for the file airbyte_agent_zoho_crm-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for airbyte_agent_zoho_crm-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7bb3394d8f756c60377273f979aeef4082d465d051f2c2d3e0a1c0416d31d9be
MD5 ebf12668acf0861cc2d990609ae63820
BLAKE2b-256 142d8c6f6e84d7ebb5bafe5bab12cfc65662e10d7ab7322c3f5b817dfac90572

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page